From: boulant <boulant>
Date: Thu, 29 Jul 2010 12:41:31 +0000 (+0000)
Subject: Updating documentation to integrate the geom python package documentation
X-Git-Tag: BR_pypkg_20100730~2
X-Git-Url: http://git.salome-platform.org/gitweb/?a=commitdiff_plain;h=1efcbd196a208391557db36e4ce91d67a32620e1;p=modules%2Fgeom.git

Updating documentation to integrate the geom python package documentation
---

diff --git a/doc/salome/gui/GEOM/images/salome-geom-structuralelements.png b/doc/salome/gui/GEOM/images/salome-geom-structuralelements.png
new file mode 100644
index 000000000..6ed41b12f
Binary files /dev/null and b/doc/salome/gui/GEOM/images/salome-geom-structuralelements.png differ
diff --git a/doc/salome/gui/GEOM/input/geompypkg.doc b/doc/salome/gui/GEOM/input/geompypkg.doc
new file mode 100644
index 000000000..3b69039e8
--- /dev/null
+++ b/doc/salome/gui/GEOM/input/geompypkg.doc
@@ -0,0 +1,35 @@
+/*!
+
+\page geompypkg_page Programming Interface of GEOM python package
+
+The GEOM python package essentially contains:
+
+<ul>
+  <li>The visualization of structural elements: a function to create
+  geometrical 3D representations of mechanical models called
+  "structural elements".
+</ul>
+
+For details, you should refer to the complete
+<a href="../../docutils/GEOM/index.html"> documentation of the GEOM
+python packages</a>, writen using sphinx.
+
+Note that these functions either encapsulate the python programming
+interface of GEOM core (the CORBA or SWIG interfaces for example) or
+extend existing utilities as the ``geompy.py`` module.
+
+The functions are distributed in the python package
+``salome.geom``. For example, the usage of the visualization of
+structural elements can be appreciated with this set of instructions:
+
+\code
+
+   from salome.geom.structelem import TEST_StructuralElement
+   TEST_StructuralElement()
+\endcode
+
+This creates the geometrical objects displayed in the study below:
+
+\image html salome-geom-structuralelements.png "Example of Geometry created from structural elements"
+
+*/
diff --git a/doc/salome/gui/GEOM/input/index.doc b/doc/salome/gui/GEOM/input/index.doc
index d28e8c343..efbf665b4 100644
--- a/doc/salome/gui/GEOM/input/index.doc
+++ b/doc/salome/gui/GEOM/input/index.doc
@@ -23,6 +23,9 @@ various algorithms;</li>
 Almost all geometry module functionalities are accessible via
 \subpage geompy_page "Geometry module Python Interface"
 
+\n Have a look also at the
+<a href="../../docutils/GEOM/index.html"> documentation of the GEOM python packages</a>
+
 \image html image3.png "Example of Geometry module usage for engineering tasks"