feat: session submodule

doc/changelog.d/3895.documentation.md

@@ -0,0 +1 @@
+feat: ``session`` submodule

doc/source/mapdl_commands/session/files.rst

@@ -1,25 +1,29 @@
-.. _ref_files_commands_api:
 
-*****
+.. _ref_files:
+
+
 Files
-*****
+=====
+
 
-.. currentmodule:: ansys.mapdl.core
+.. currentmodule:: ansys.mapdl.core._commands.session.files
 
-These SESSION commands are for file operations, such as deleting,
-copying, and listing.
+.. autoclass:: ansys.mapdl.core._commands.session.files.Files
 
 .. autosummary::
-   :toctree: _autosummary/
-
-   Mapdl.anstoaqwa
-   Mapdl.anstoasas
-   Mapdl.assign
-   Mapdl.copy
-   Mapdl.slashdelete
-   Mapdl.fcomp
-   Mapdl.lgwrite
-   Mapdl.starlist
-   Mapdl.slashclog
-   Mapdl.slashfdele
-   Mapdl.rename
+   :template: base.rst
+   :toctree: _autosummary
+
+
+   Files.anstoaqwa
+   Files.anstoasas
+   Files.assign
+   Files.copy
+   Files.fclean
+   Files.fcomp
+   Files.lgwrite
+   Files.slashclog
+   Files.slashdelete
+   Files.slashfdele
+   Files.slashrename
+   Files.starlist

doc/source/mapdl_commands/session/index.rst

@@ -0,0 +1,22 @@
+
+.. _ref_session:
+
+Session
+=======
+
+.. list-table::
+
+   * - :ref:`ref_files`
+   * - :ref:`ref_list_controls`
+   * - :ref:`ref_run_controls`
+   * - :ref:`ref_processor_entry`
+
+
+.. toctree::
+   :maxdepth: 1
+   :hidden:
+
+   files
+   list_controls
+   run_controls
+   processor_entry

doc/source/mapdl_commands/session/list_controls.rst

@@ -1,18 +1,23 @@
-.. _ref_list_controls_commands_api:
 
-*************
-List controls
-*************
+.. _ref_list_controls:
 
-.. currentmodule:: ansys.mapdl.core
 
-These SESSION commands are used to control listings and printed program output.
+ListControls
+============
+
+
+.. currentmodule:: ansys.mapdl.core._commands.session.list_controls
+
+.. autoclass:: ansys.mapdl.core._commands.session.list_controls.ListControls
 
 .. autosummary::
-   :toctree: _autosummary/
+   :template: base.rst
+   :toctree: _autosummary
+
 
-   Mapdl.com
-   Mapdl.golist
-   Mapdl.gopr
-   Mapdl.nolist
-   Mapdl.nopr
+   ListControls.com
+   ListControls.golist
+   ListControls.gopr
+   ListControls.nolist
+   ListControls.nopr
+   ListControls.slashgo

doc/source/mapdl_commands/session/processor_entry.rst

@@ -1,24 +1,23 @@
-.. _ref_processor_entry_commands_api:
 
-***************
-Processor entry
-***************
+.. _ref_processor_entry:
 
-.. currentmodule:: ansys.mapdl.core
 
-These SESSION commands are used to enter and exit the various processors in the program.
+ProcessorEntry
+==============
+
+
+.. currentmodule:: ansys.mapdl.core._commands.session.processor_entry
+
+.. autoclass:: ansys.mapdl.core._commands.session.processor_entry.ProcessorEntry
 
 .. autosummary::
-   :toctree: _autosummary/
-
-   Mapdl.aux2
-   Mapdl.aux3
-   Mapdl.aux12
-   Mapdl.aux15
-   Mapdl.finish
-   Mapdl.map
-   Mapdl.post1
-   Mapdl.post26
-   Mapdl.prep7
-   Mapdl.quit
-   Mapdl.slashsolu
+   :template: base.rst
+   :toctree: _autosummary
+
+
+   ProcessorEntry.finish
+   ProcessorEntry.post1
+   ProcessorEntry.post26
+   ProcessorEntry.prep7
+   ProcessorEntry.quit
+   ProcessorEntry.slashsolu

doc/source/mapdl_commands/session/run_controls.rst

@@ -1,29 +1,34 @@
-.. _ref_run_controls_commands_api:
 
-************
-Run controls
-************
+.. _ref_run_controls:
 
-.. currentmodule:: ansys.mapdl.core
 
-These SESSION commands control the overall characteristics of the
-session, including the job name, Graphical User Interface behavior, and
-file switching.
+RunControls
+===========
+
+
+.. currentmodule:: ansys.mapdl.core._commands.session.run_controls
+
+.. autoclass:: ansys.mapdl.core._commands.session.run_controls.RunControls
 
 .. autosummary::
-   :toctree: _autosummary/
-
-   Mapdl.config
-   Mapdl.cwd
-   Mapdl.exit
-   Mapdl.filname
-   Mapdl.input
-   Mapdl.keyw
-   Mapdl.memm
-   Mapdl.nerr
-   Mapdl.pause
-   Mapdl.slashstatus
-   Mapdl.starstatus
-   Mapdl.syp
-   Mapdl.sys
-   Mapdl.unpause
+   :template: base.rst
+   :toctree: _autosummary
+
+
+   RunControls.config
+   RunControls.cwd
+   RunControls.filname
+   RunControls.input
+   RunControls.keyw
+   RunControls.memm
+   RunControls.menu
+   RunControls.mstart
+   RunControls.nerr
+   RunControls.output
+   RunControls.pause
+   RunControls.slashstatus
+   RunControls.syp
+   RunControls.sys
+   RunControls.ui
+   RunControls.uis
+   RunControls.unpause

src/ansys/mapdl/core/_commands/session/__init__.py

@@ -20,4 +20,9 @@
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 # SOFTWARE.
 
-from . import files, list_controls, processor_entry, run_controls
+from . import (
+    files,
+    list_controls,
+    processor_entry,
+    run_controls,
+)