ansys · clatapie · Apr 23, 2025 · Feb 17, 2025 · Feb 17, 2025 · Feb 17, 2025
diff --git a/.github/workflows/doc-build.yml b/.github/workflows/doc-build.yml
@@ -180,7 +180,7 @@ jobs:
       - name: "Build documentation"
         shell: bash
         run: |
-          xvfb-run make -C doc html SPHINXOPTS="-j auto -W --keep-going"
+          xvfb-run make -C doc html SPHINXOPTS="-j auto"
 
       - name: "Substitute defective GIF"
         shell: bash

diff --git a/doc/changelog.d/3748.documentation.md b/doc/changelog.d/3748.documentation.md
@@ -0,0 +1 @@
+feat: ``database`` submodule
diff --git a/doc/source/mapdl_commands/database/components.rst b/doc/source/mapdl_commands/database/components.rst
@@ -1,23 +1,26 @@
-.. _ref_components_api:
 
-**********
+.. _ref_components:
+
+
 Components
-**********
+==========
+
 
-.. currentmodule:: ansys.mapdl.core
+.. currentmodule:: ansys.mapdl.core._commands.database.components
 
-These DATABASE commands allow selected subsets of entities to be named
-as components for easy selection later on.
+.. autoclass:: ansys.mapdl.core._commands.database.components.Components
 
 .. autosummary::
-   :toctree: _autosummary/
-
-   Mapdl.cm
-   Mapdl.cmdele
-   Mapdl.cmedit
-   Mapdl.cmgrp
-   Mapdl.cmlist
-   Mapdl.cmmod
-   Mapdl.cmplot
-   Mapdl.cmsel
-   Mapdl.cmwrite
+   :template: base.rst
+   :toctree: _autosummary
+
+
+   Components.cm
+   Components.cmdele
+   Components.cmedit
+   Components.cmgrp
+   Components.cmlist
+   Components.cmmod
+   Components.cmplot
+   Components.cmsel
+   Components.cmwrite
diff --git a/doc/source/mapdl_commands/database/coord_sys.rst b/doc/source/mapdl_commands/database/coord_sys.rst
diff --git a/doc/source/mapdl_commands/database/coordinate_system.rst b/doc/source/mapdl_commands/database/coordinate_system.rst
@@ -0,0 +1,26 @@
+
+.. _ref_coordinate_system:
+
+
+CoordinateSystem
+================
+
+
+.. currentmodule:: ansys.mapdl.core._commands.database.coordinate_system
+
+.. autoclass:: ansys.mapdl.core._commands.database.coordinate_system.CoordinateSystem
+
+.. autosummary::
+   :template: base.rst
+   :toctree: _autosummary
+
+
+   CoordinateSystem.clocal
+   CoordinateSystem.cs
+   CoordinateSystem.cscir
+   CoordinateSystem.csdele
+   CoordinateSystem.cskp
+   CoordinateSystem.cslist
+   CoordinateSystem.cswpla
+   CoordinateSystem.csys
+   CoordinateSystem.local
diff --git a/doc/source/mapdl_commands/database/index.rst b/doc/source/mapdl_commands/database/index.rst
@@ -0,0 +1,26 @@
+
+.. _ref_database:
+
+Database
+========
+
+.. list-table::
+
+   * - :ref:`ref_selecting`
+   * - :ref:`ref_coordinate_system`
+   * - :ref:`ref_working_plane`
+   * - :ref:`ref_set_up`
+   * - :ref:`ref_components`
+   * - :ref:`ref_picking`
+
+
+.. toctree::
+   :maxdepth: 1
+   :hidden:
+
+   selecting
+   coordinate_system
+   working_plane
+   set_up
+   components
+   picking
diff --git a/doc/source/mapdl_commands/database/picking.rst b/doc/source/mapdl_commands/database/picking.rst
@@ -1,18 +1,19 @@
-.. _ref_picking_api:
 
-*******
+.. _ref_picking:
+
+
 Picking
-*******
+=======
 
-.. currentmodule:: ansys.mapdl.core
 
-These DATABASE commands are generated by the GUI when picking
-operations are performed. They can also be used to add additional
-parameters to a command. For example, more points to a spline than
-would be normally supported.
+.. currentmodule:: ansys.mapdl.core._commands.database.picking
+
+.. autoclass:: ansys.mapdl.core._commands.database.picking.Picking
 
 .. autosummary::
-   :toctree: _autosummary/
+   :template: base.rst
+   :toctree: _autosummary
+
 
-   Mapdl.fitem
-   Mapdl.flst
+   Picking.fitem
+   Picking.flst
diff --git a/doc/source/mapdl_commands/database/selecting.rst b/doc/source/mapdl_commands/database/selecting.rst
@@ -1,39 +1,42 @@
-.. _ref_selecting_api:
 
-*********
+.. _ref_selecting:
+
+
 Selecting
-*********
+=========
+
 
-.. currentmodule:: ansys.mapdl.core
+.. currentmodule:: ansys.mapdl.core._commands.database.selecting
 
-These DATABASE commands are used to select subsets of database
-entities for further operations.
+.. autoclass:: ansys.mapdl.core._commands.database.selecting.Selecting
 
 .. autosummary::
-   :toctree: _autosummary/
-
-   Mapdl.allsel
-   Mapdl.asll
-   Mapdl.asel
-   Mapdl.aslv
-   Mapdl.dofsel
-   Mapdl.esel
-   Mapdl.esla
-   Mapdl.esll
-   Mapdl.esln
-   Mapdl.eslv
-   Mapdl.ksel
-   Mapdl.ksll
-   Mapdl.ksln
-   Mapdl.lsel
-   Mapdl.lsla
-   Mapdl.lslk
-   Mapdl.nsel
-   Mapdl.nsla
-   Mapdl.nsle
-   Mapdl.nslk
-   Mapdl.nsll
-   Mapdl.nslv
-   Mapdl.partsel
-   Mapdl.vsel
-   Mapdl.vsla
+   :template: base.rst
+   :toctree: _autosummary
+
+
+   Selecting.allsel
+   Selecting.asel
+   Selecting.asll
+   Selecting.aslv
+   Selecting.dofsel
+   Selecting.esel
+   Selecting.esla
+   Selecting.esll
+   Selecting.esln
+   Selecting.eslv
+   Selecting.ksel
+   Selecting.ksll
+   Selecting.ksln
+   Selecting.lsel
+   Selecting.lsla
+   Selecting.lslk
+   Selecting.nsel
+   Selecting.nsla
+   Selecting.nsle
+   Selecting.nslk
+   Selecting.nsll
+   Selecting.nslv
+   Selecting.seltol
+   Selecting.vsel
+   Selecting.vsla
diff --git a/doc/source/mapdl_commands/database/set_up.rst b/doc/source/mapdl_commands/database/set_up.rst
@@ -0,0 +1,24 @@
+
+.. _ref_set_up:
+
+
+SetUp
+=====
+
+
+.. currentmodule:: ansys.mapdl.core._commands.database.set_up
+
+.. autoclass:: ansys.mapdl.core._commands.database.set_up.SetUp
+
+.. autosummary::
+   :template: base.rst
+   :toctree: _autosummary
+
+
+   SetUp.resume
+   SetUp.save
+   SetUp.smbc
+   SetUp.stat
+   SetUp.stitle
+   SetUp.title
+   SetUp.units
diff --git a/doc/source/mapdl_commands/database/setup.rst b/doc/source/mapdl_commands/database/setup.rst
diff --git a/doc/source/mapdl_commands/database/working_plane.rst b/doc/source/mapdl_commands/database/working_plane.rst
@@ -1,25 +1,28 @@
-.. _ref_working_plane_api:
 
-*************
-Working plane
-*************
+.. _ref_working_plane:
 
-.. currentmodule:: ansys.mapdl.core
 
-These DATABASE commands turn on, move, rotate, and modify the working
-plane, which is used for picking operations.
+WorkingPlane
+============
+
+
+.. currentmodule:: ansys.mapdl.core._commands.database.working_plane
+
+.. autoclass:: ansys.mapdl.core._commands.database.working_plane.WorkingPlane
 
 .. autosummary::
-   :toctree: _autosummary/
-
-   Mapdl.kwpave
-   Mapdl.kwplan
-   Mapdl.lwplan
-   Mapdl.nwpave
-   Mapdl.nwplan
-   Mapdl.wpave
-   Mapdl.wpcsys
-   Mapdl.wplane
-   Mapdl.wpoffs
-   Mapdl.wprota
-   Mapdl.wpstyl
+   :template: base.rst
+   :toctree: _autosummary
+
+
+   WorkingPlane.kwpave
+   WorkingPlane.kwplan
+   WorkingPlane.lwplan
+   WorkingPlane.nwpave
+   WorkingPlane.nwplan
+   WorkingPlane.wpave
+   WorkingPlane.wpcsys
+   WorkingPlane.wplane
+   WorkingPlane.wpoffs
+   WorkingPlane.wprota
+   WorkingPlane.wpstyl
diff --git a/src/ansys/mapdl/core/_commands/database/__init__.py b/src/ansys/mapdl/core/_commands/database/__init__.py
@@ -20,4 +20,11 @@
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 # SOFTWARE.
 
-from . import components, coord_sys, picking, selecting, setup, working_plane
+from . import (
+    components,
+    coordinate_system,
+    picking,
+    selecting,
+    set_up,
+    working_plane,
+)