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:`sketcher` -- Wrapper to help the creation of simple sketches
  20 ------------------------------------------------------------------
  21
  22 .. automodule:: salome.geom.sketcher
  23    :members:
  24
  25 .. autoclass:: Sketcher
  26    :members:
  27
  28 :mod:`structelem` -- Structural elements package
  29 ------------------------------------------------
  30
  31 .. automodule:: salome.geom.structelem
  32
  33 .. autoclass:: StructuralElementManager
  34    :members:
  35
  36 .. autoclass:: StructuralElement
  37    :members:
  38
  39 :mod:`structelem.parts` -- Structural element parts
  40 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  41
  42 .. automodule:: salome.geom.structelem.parts
  43    :members:
  44    :undoc-members:
  45    :show-inheritance:
  46
  47 :mod:`structelem.orientation` -- Structural element orientation
  48 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  49
  50 .. automodule:: salome.geom.structelem.orientation
  51    :members:
  52    :undoc-members: