]> SALOME platform Git repositories - modules/geom.git/commitdiff
Salome HOME
Fixed documentation
authorbarate <barate>
Fri, 25 Mar 2011 10:35:27 +0000 (10:35 +0000)
committerbarate <barate>
Fri, 25 Mar 2011 10:35:27 +0000 (10:35 +0000)
doc/docutils/index.rst
doc/docutils/overview.rst
doc/salome/gui/GEOM/Makefile.am
doc/salome/gui/GEOM/images/salome-geom-structuralelements.png [deleted file]
doc/salome/gui/GEOM/input/geompypkg.doc [deleted file]
doc/salome/gui/GEOM/input/index.doc

index 81e4f24aa6ea2ad32d591dfa5416ad04f008757a..2a0233d4eeb906b53e132cbfbee3e141a3638e56 100644 (file)
@@ -1,11 +1,8 @@
 
 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
- Documentation of the GEOM python packages
+ Documentation of the GEOM python package
 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 
-Main documentation
-==================
-
 .. toctree::
    :maxdepth: 3
 
index 3ca3a4b20f2dd3fc8ea16914834ad3dab67dc28e..f873cd607b1eb55998c1d60ad9ff903e5553c568 100644 (file)
@@ -8,10 +8,7 @@ The GEOM python package essentially contains:
 * The visualization of structural elements: a function to create
   geometrical 3D representations of mechanical models called
   "structural elements".
-
-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.
+* 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
index 644b5cc6203e4db5cec74b249cde6ff6f32eb90f..a3eb7c31fe97dd47f0a091ebb42fef73fa9da2dd 100755 (executable)
@@ -62,7 +62,7 @@ clean-local:
        done ;
 
 install-data-local: usr_docs
-       @if [ -e main.html ]; then \
+       @if [ -e index.html ]; then \
        $(INSTALL) -d $(DESTDIR)$(docdir)/gui/GEOM ; \
        for filen in `find . -maxdepth 1` ; do                                                  \
          case $${filen} in                                                                     \
diff --git a/doc/salome/gui/GEOM/images/salome-geom-structuralelements.png b/doc/salome/gui/GEOM/images/salome-geom-structuralelements.png
deleted file mode 100644 (file)
index 6ed41b1..0000000
Binary files a/doc/salome/gui/GEOM/images/salome-geom-structuralelements.png and /dev/null differ
diff --git a/doc/salome/gui/GEOM/input/geompypkg.doc b/doc/salome/gui/GEOM/input/geompypkg.doc
deleted file mode 100644 (file)
index bd50795..0000000
+++ /dev/null
@@ -1,44 +0,0 @@
-/*!
-
-\page geompypkg_page Programming Interface of GEOM python package
-
-Sorry, but the documentation is not available yet in doxygen format.
-
-Fortunately, a documentation exists in restructured format and then
-can be generated here using sphinx, in the expectative of the doxygen
-version. This documentation is available <a href="../../tui/GEOM/docutils/index.html">
-here</a>.
-
-Here is a sample generated from the doxygen format:
-
-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="../../tui/GEOM/docutils/index.html"> documentation of the GEOM
-python packages</a> generated with sphinx from rst text files.
-
-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"
-
-*/
index b4368cbcd8ee28ce3ea646ccd9cfc2d18b16a240..3305549fb19e5abf87432265a73194739bb257b5 100644 (file)
@@ -23,7 +23,7 @@ various algorithms;</li>
 Almost all geometry module functionalities are accessible via
 \subpage geompy_page "Geometry module Python Interface"
 
-Also it can be useful to have a look at the \subpage geompypkg_page "documentation on GEOM python packages".
+Other functions are available in <a class="el" target="_new" href="../../tui/GEOM/docutils/index.html">salome.geom python package</a>.
 
 \image html image3.png "Example of Geometry module usage for engineering tasks"