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 :mod:`geomtools` -- Tools to access GEOM engine and objects
  14 -----------------------------------------------------------
  15
  16 .. automodule:: salome.geom.geomtools
  17    :members:
  18
  19 :mod:`structelem` -- Structural elements package
  20 ------------------------------------------------
  21
  22 .. automodule:: salome.geom.structelem
  23
  24 .. autoclass:: StructuralElementManager
  25    :members:
  26
  27 .. autoclass:: StructuralElement
  28    :members:
  29
  30 :mod:`structelem.parts` -- Structural element parts
  31 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  32
  33 .. automodule:: salome.geom.structelem.parts
  34    :members:
  35    :undoc-members:
  36    :show-inheritance:
  37
  38 :mod:`structelem.orientation` -- Structural element orientation
  39 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  40
  41 .. automodule:: salome.geom.structelem.orientation
  42    :members:
  43    :undoc-members: