ForkMaster/smesh
1
0
Fork 0
mirror of https://git.salome-platform.org/gitpub/modules/smesh.git synced 2024-12-24 16:30:34 +05:00
Code Issues Packages Projects Releases Wiki Activity

Fixed documentation for Python package (opens in a new window)

Browse Source
This commit is contained in:
barate 2011-03-25 14:34:31 +00:00
parent 7a6a25502e
commit cacc7209a0
4 changed files with 4 additions and 23 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
doc/docutils/index.rst
View File

@ -1,14 +1,10 @@
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
Documentation of the SMESH python packages
Documentation of the SMESH python package
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
Main documentation
==================
.. toctree::
:maxdepth: 3
overview.rst
docapi.rst

4
doc/docutils/overview.rst
View File

@ -3,8 +3,8 @@
General presentation of the SMESH python package
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
The SMESH python package contains (today) helpser functions to
manipulate mesh elements and interact with this elements.
The SMESH python package contains (today) helper functions to
manipulate mesh elements and interact with these elements.
Note that these functions either encapsulate the python programming
interface of SMESH core (the CORBA or SWIG interface for example) or

3
doc/salome/gui/SMESH/input/index.doc
View File

@ -26,8 +26,7 @@ array of dedicated operations;</li>
Almost all mesh module functionalities are accessible via
\subpage smeshpy_interface_page "Mesh module Python interface".
Also it can be useful to have a look at the
\subpage smeshpypkg_page "documentation on SMESH python package".
Other functions are available in <a class="el" target="_new" href="../../tui/SMESH/docutils/index.html">salome.smesh python package</a>.
\image html image7.jpg "Example of MESH module usage for engineering tasks"

14
doc/salome/gui/SMESH/input/smeshpypkg.doc
View File

@ -1,14 +0,0 @@
/*!
\page smeshpypkg_page Programming Interface of the SMESH 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.
Please refer to this <a href="../../tui/SMESH/docutils/index.html">
documentation of the SMESH python packages</a>.
*/