From: barate <barate>
Date: Fri, 25 Mar 2011 10:35:27 +0000 (+0000)
Subject: Fixed documentation
X-Git-Tag: Start_BR_19998_21191~22
X-Git-Url: http://git.salome-platform.org/gitweb/?a=commitdiff_plain;h=7d85bf719a038ac57e8921ca8b408722acb17fe2;p=modules%2Fgeom.git

Fixed documentation
---

diff --git a/doc/docutils/index.rst b/doc/docutils/index.rst
index 81e4f24aa..2a0233d4e 100644
--- a/doc/docutils/index.rst
+++ b/doc/docutils/index.rst
@@ -1,11 +1,8 @@
 
 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
- Documentation of the GEOM python packages
+ Documentation of the GEOM python package
 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 
-Main documentation
-==================
-
 .. toctree::
    :maxdepth: 3
 
diff --git a/doc/docutils/overview.rst b/doc/docutils/overview.rst
index 3ca3a4b20..f873cd607 100644
--- a/doc/docutils/overview.rst
+++ b/doc/docutils/overview.rst
@@ -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
diff --git a/doc/salome/gui/GEOM/Makefile.am b/doc/salome/gui/GEOM/Makefile.am
index 644b5cc62..a3eb7c31f 100755
--- a/doc/salome/gui/GEOM/Makefile.am
+++ b/doc/salome/gui/GEOM/Makefile.am
@@ -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
index 6ed41b12f..000000000
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
index bd507959a..000000000
--- a/doc/salome/gui/GEOM/input/geompypkg.doc
+++ /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"
-
-*/
diff --git a/doc/salome/gui/GEOM/input/index.doc b/doc/salome/gui/GEOM/input/index.doc
index b4368cbcd..3305549fb 100644
--- a/doc/salome/gui/GEOM/input/index.doc
+++ b/doc/salome/gui/GEOM/input/index.doc
@@ -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"