ForkMaster/geom
1
0
Fork 0
mirror of https://git.salome-platform.org/gitpub/modules/geom.git synced 2025-01-18 14:10:38 +05:00
Code Issues Packages Projects Releases Wiki Activity

Fixed documentation

Browse Source
This commit is contained in:
barate 2011-03-25 10:35:27 +00:00
parent c86487eae5
commit 7d85bf719a
6 changed files with 4 additions and 54 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
doc/docutils/index.rst
View File

@ -1,11 +1,8 @@
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
Documentation of the GEOM python packages
Documentation of the GEOM python package
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
Main documentation
==================
.. toctree::
:maxdepth: 3

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

2
doc/salome/gui/GEOM/Makefile.am
View File

@ -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 \

BIN
doc/salome/gui/GEOM/images/salome-geom-structuralelements.png
View File

Binary file not shown.
Side by Side

Before

Width:  |  Height:  |  Size: 168 KiB

44
doc/salome/gui/GEOM/input/geompypkg.doc
View File

@ -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"
*/

2
doc/salome/gui/GEOM/input/index.doc
View 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"