feat: graphics submodule

doc/changelog.d/3750.documentation.md

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

doc/source/mapdl_commands/graphics/annotation.rst

@@ -1,26 +1,31 @@
-.. _ref_annotation_api:
 
-**********
+.. _ref_annotation:
+
+
 Annotation
-**********
+==========
+
 
-.. currentmodule:: ansys.mapdl.core
+.. currentmodule:: ansys.mapdl.core._commands.graphics.annotation
 
-These GRAPHICS commands are used to annotate a display with notes and
-symbols.
+.. autoclass:: ansys.mapdl.core._commands.graphics.annotation.Annotation
 
 .. autosummary::
-   :toctree: _autosummary/
-
-   Mapdl.an3d
-   Mapdl.annot
-   Mapdl.anum
-   Mapdl.lspec
-   Mapdl.lsymbol
-   Mapdl.slash_pcircle
-   Mapdl.pmore
-   Mapdl.polygon
-   Mapdl.pspec
-   Mapdl.pwedge
-   Mapdl.tlabel
-   Mapdl.tspec
+   :template: base.rst
+   :toctree: _autosummary
+
+
+   Annotation.an3d
+   Annotation.annot
+   Annotation.anum
+   Annotation.lspec
+   Annotation.lsymbol
+   Annotation.pcircle
+   Annotation.pmore
+   Annotation.polygon
+   Annotation.pwedge
+   Annotation.slashlarc
+   Annotation.slashline
+   Annotation.slashpspec
+   Annotation.tlabel
+   Annotation.tspec

doc/source/mapdl_commands/graphics/graphs.rst

@@ -1,21 +1,24 @@
-.. _ref_graphs_api:
 
-******
+.. _ref_graphs:
+
+
 Graphs
-******
+======
+
 
-.. currentmodule:: ansys.mapdl.core
+.. currentmodule:: ansys.mapdl.core._commands.graphics.graphs
 
-These GRAPHICS commands are used to control the way line graphs are
-displayed.
+.. autoclass:: ansys.mapdl.core._commands.graphics.graphs.Graphs
 
 .. autosummary::
-   :toctree: _autosummary/
-
-   Mapdl.axlab
-   Mapdl.grid
-   Mapdl.gropt
-   Mapdl.grtyp
-   Mapdl.gthk
-   Mapdl.xrange
-   Mapdl.yrange
+   :template: base.rst
+   :toctree: _autosummary
+
+
+   Graphs.axlab
+   Graphs.grid
+   Graphs.gropt
+   Graphs.grtyp
+   Graphs.gthk
+   Graphs.xrange
+   Graphs.yrange

doc/source/mapdl_commands/graphics/index.rst

@@ -0,0 +1,28 @@
+
+.. _ref_graphics:
+
+Graphics
+========
+
+.. list-table::
+
+   * - :ref:`ref_style`
+   * - :ref:`ref_annotation`
+   * - :ref:`ref_labeling`
+   * - :ref:`ref_set_up`
+   * - :ref:`ref_views`
+   * - :ref:`ref_graphs`
+   * - :ref:`ref_scaling`
+
+
+.. toctree::
+   :maxdepth: 1
+   :hidden:
+
+   style
+   annotation
+   labeling
+   set_up
+   views
+   graphs
+   scaling

doc/source/mapdl_commands/graphics/labeling.rst

@@ -1,29 +1,32 @@
-.. _ref_labeling_api:
 
-********
+.. _ref_labeling:
+
+
 Labeling
-********
+========
+
 
-.. currentmodule:: ansys.mapdl.core
+.. currentmodule:: ansys.mapdl.core._commands.graphics.labeling
 
-These GRAPHICS commands are used to add helpful labels and symbols to
-displays.
+.. autoclass:: ansys.mapdl.core._commands.graphics.labeling.Labeling
 
 .. autosummary::
-   :toctree: _autosummary/
-
-   Mapdl.cformat
-   Mapdl.clabel
-   Mapdl.contour
-   Mapdl.cval
-   Mapdl.gformat
-   Mapdl.hbc
-   Mapdl.number
-   Mapdl.pbc
-   Mapdl.pbf
-   Mapdl.plopts
-   Mapdl.pnum
-   Mapdl.psf
-   Mapdl.psymb
-   Mapdl.triad
-   Mapdl.udoc
+   :template: base.rst
+   :toctree: _autosummary
+
+
+   Labeling.cformat
+   Labeling.clabel
+   Labeling.contour
+   Labeling.cval
+   Labeling.gformat
+   Labeling.hbc
+   Labeling.number
+   Labeling.pbc
+   Labeling.pbf
+   Labeling.plopts
+   Labeling.pnum
+   Labeling.psf
+   Labeling.psymb
+   Labeling.triad
+   Labeling.udoc

doc/source/mapdl_commands/graphics/scaling.rst

@@ -1,21 +1,24 @@
-.. _ref_scaling_api:
 
-*******
+.. _ref_scaling:
+
+
 Scaling
-*******
+=======
+
 
-.. currentmodule:: ansys.mapdl.core
+.. currentmodule:: ansys.mapdl.core._commands.graphics.scaling
 
-These GRAPHICS commands are used to scale various parts of the
-display.
+.. autoclass:: ansys.mapdl.core._commands.graphics.scaling.Scaling
 
 .. autosummary::
-   :toctree: _autosummary/
-
-   Mapdl.iclwid
-   Mapdl.icscale
-   Mapdl.ratio
-   Mapdl.shrink
-   Mapdl.sscale
-   Mapdl.txtre
-   Mapdl.vscale
+   :template: base.rst
+   :toctree: _autosummary
+
+
+   Scaling.iclwid
+   Scaling.icscale
+   Scaling.ratio
+   Scaling.shrink
+   Scaling.slashdscale
+   Scaling.sscale
+   Scaling.vscale

doc/source/mapdl_commands/graphics/set_up.rst

@@ -0,0 +1,43 @@
+
+.. _ref_set_up:
+
+
+SetUp
+=====
+
+
+.. currentmodule:: ansys.mapdl.core._commands.graphics.set_up
+
+.. autoclass:: ansys.mapdl.core._commands.graphics.set_up.SetUp
+
+.. autosummary::
+   :template: base.rst
+   :toctree: _autosummary
+
+
+   SetUp.cmap
+   SetUp.color
+   SetUp.device
+   SetUp.dsys
+   SetUp.dv3d
+   SetUp.gcmd
+   SetUp.gcolumn
+   SetUp.gfile
+   SetUp.gplot
+   SetUp.graphics
+   SetUp.gresume
+   SetUp.gsave
+   SetUp.gtype
+   SetUp.image
+   SetUp.immed
+   SetUp.jpeg
+   SetUp.mrep
+   SetUp.noerase
+   SetUp.pngr
+   SetUp.pstatus
+   SetUp.replot
+   SetUp.seg
+   SetUp.show
+   SetUp.slashreset
+   SetUp.tiff
+   SetUp.window

doc/source/mapdl_commands/graphics/style.rst

@@ -1,26 +1,31 @@
-.. _ref_style_api:
 
-*****
+.. _ref_style:
+
+
 Style
-*****
+=====
+
 
-.. currentmodule:: ansys.mapdl.core
+.. currentmodule:: ansys.mapdl.core._commands.graphics.style
 
-These GRAPHICS commands are used to change the way a model is
-displayed.
+.. autoclass:: ansys.mapdl.core._commands.graphics.style.Style
 
 .. autosummary::
-   :toctree: _autosummary/
-
-   Mapdl.cplane
-   Mapdl.ctype
-   Mapdl.edge
-   Mapdl.eshape
-   Mapdl.facet
-   Mapdl.gline
-   Mapdl.gmarker
-   Mapdl.gmface
-   Mapdl.light
-   Mapdl.normal
-   Mapdl.shade
-   Mapdl.trlcy
+   :template: base.rst
+   :toctree: _autosummary
+
+
+   Style.cplane
+   Style.ctype
+   Style.edge
+   Style.eshape
+   Style.facet
+   Style.gline
+   Style.gmarker
+   Style.gmface
+   Style.light
+   Style.normal
+   Style.shade
+   Style.slashtype
+   Style.trlcy
+   Style.txtre