From: boulant Date: Wed, 25 Jan 2012 14:40:42 +0000 (+0000) Subject: Add documentation for the python module sketcher.py X-Git-Tag: V6_5_0a1~88 X-Git-Url: http://git.salome-platform.org/gitweb/?a=commitdiff_plain;h=50e7c6671c01be9212c65f43733b186eedd17035;p=modules%2Fgeom.git Add documentation for the python module sketcher.py --- diff --git a/doc/docutils/docapi.rst b/doc/docutils/docapi.rst index 20a52ca80..6f9140b05 100644 --- a/doc/docutils/docapi.rst +++ b/doc/docutils/docapi.rst @@ -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 ------------------------------------------------ diff --git a/doc/docutils/overview.rst b/doc/docutils/overview.rst index f873cd607..78a47b50b 100644 --- a/doc/docutils/overview.rst +++ b/doc/docutils/overview.rst @@ -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