doc/docutils/docapi.rst

   1
   2 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
   3  Documentation of the programming interface (API)
   4 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
   5
   6 This section describes the python packages and modules of the
   7 ``salome.geom`` python package. The main part is generated from the
   8 code documentation included in source python files.
   9
  10 :mod:`salome.geom` -- Package containing the GEOM python utilities
  11 ==================================================================
  12
  13 .. text below is (temporary?) commented since importing geomtools
  14 .. requires SALOME to be running
  15
  16 .. %%%:mod:`geomtools` -- Tools to access GEOM engine and objects
  17 .. %%%-----------------------------------------------------------
  18
  19 .. %%%%automodule:: salome.geom.geomtools
  20    .. %%%%:members:
  21
  22 .. %%%:mod:`structelem` -- Structural elements package
  23 .. %%%------------------------------------------------
  24
  25 .. %%%.. automodule:: salome.geom.structelem
  26
  27 .. %%%.. autoclass:: StructuralElementManager
  28    :members:
  29
  30 .. %%%.. autoclass:: StructuralElement
  31    :members:
  32
  33 .. %%%:mod:`structelem.parts` -- Structural element parts
  34 .. %%%^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  35
  36 .. %%%.. automodule:: salome.geom.structelem.parts
  37    :members:
  38    :undoc-members:
  39    :show-inheritance:
  40
  41 .. %%%:mod:`structelem.orientation` -- Structural element orientation
  42 .. %%%^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  43
  44 .. %%%.. automodule:: salome.geom.structelem.orientation
  45    :members:
  46    :undoc-members: