ForkMaster/geom
1
0
Fork 0
mirror of https://git.salome-platform.org/gitpub/modules/geom.git synced 2024-11-15 10:08:35 +05:00
Code Issues Packages Projects Releases Wiki Activity

Add documentation for the python module sketcher.py

Browse Source
This commit is contained in:
boulant 2012-01-25 14:40:42 +00:00
parent 10c8c3b62f
commit 50e7c6671c
2 changed files with 13 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
doc/docutils/docapi.rst
View 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
------------------------------------------------

5
doc/docutils/overview.rst
View 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