]> SALOME platform Git repositories - modules/geom.git/commitdiff
Salome HOME
Add documentation for the python module sketcher.py
authorboulant <boulant>
Wed, 25 Jan 2012 14:40:42 +0000 (14:40 +0000)
committerboulant <boulant>
Wed, 25 Jan 2012 14:40:42 +0000 (14:40 +0000)
doc/docutils/docapi.rst
doc/docutils/overview.rst

index 20a52ca8037e85901e1beb0ef8eccb0f43fc17f4..6f9140b054d50861fb81f791fd04a12ef5b22dd5 100644 (file)
@@ -16,6 +16,15 @@ code documentation included in source python files.
 .. automodule:: salome.geom.geomtools
    :members:
 
+:mod:`sketcher` -- Wrapper to help the creation of simple sketches
+------------------------------------------------------------------
+
+.. automodule:: salome.geom.sketcher
+   :members:
+
+.. autoclass:: Sketcher
+   :members:
+
 :mod:`structelem` -- Structural elements package
 ------------------------------------------------
 
index f873cd607b1eb55998c1d60ad9ff903e5553c568..78a47b50bd52ca7ae114bf764981aacb7959cf36 100644 (file)
@@ -5,10 +5,13 @@ General presentation of the GEOM python package
 
 The GEOM python package essentially contains:
 
+* Utility functions to handle GEOM items in Salome study.
+* Wrapping functions to help the usage of existing tools:
+
+  - a sketcher module to create sketches from the python API   
 * The visualization of structural elements: a function to create
   geometrical 3D representations of mechanical models called
   "structural elements".
-* Utility functions to handle GEOM items in Salome study.
 
 The functions are distributed in the python package
 ``salome.geom``. For example, the usage of the visualization of