geom/doc/docutils/docapi.rst
eap 93ac97913e Fix errors in generating documentation by SPHINX
+.. text below is (temporary?) commented since importing geomtools
+.. requires SALOME to be running
2011-11-15 16:10:23 +00:00

47 lines
1.5 KiB
ReStructuredText

%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
Documentation of the programming interface (API)
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
This section describes the python packages and modules of the
``salome.geom`` python package. The main part is generated from the
code documentation included in source python files.
:mod:`salome.geom` -- Package containing the GEOM python utilities
==================================================================
.. text below is (temporary?) commented since importing geomtools
.. requires SALOME to be running
.. %%%:mod:`geomtools` -- Tools to access GEOM engine and objects
.. %%%-----------------------------------------------------------
.. %%%%automodule:: salome.geom.geomtools
.. %%%%:members:
.. %%%:mod:`structelem` -- Structural elements package
.. %%%------------------------------------------------
.. %%%.. automodule:: salome.geom.structelem
.. %%%.. autoclass:: StructuralElementManager
:members:
.. %%%.. autoclass:: StructuralElement
:members:
.. %%%:mod:`structelem.parts` -- Structural element parts
.. %%%^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. %%%.. automodule:: salome.geom.structelem.parts
:members:
:undoc-members:
:show-inheritance:
.. %%%:mod:`structelem.orientation` -- Structural element orientation
.. %%%^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. %%%.. automodule:: salome.geom.structelem.orientation
:members:
:undoc-members: