From: barate Date: Fri, 25 Mar 2011 14:34:31 +0000 (+0000) Subject: Fixed documentation for Python package (opens in a new window) X-Git-Tag: Start_BR_19998_21191~7 X-Git-Url: http://git.salome-platform.org/gitweb/?a=commitdiff_plain;h=cacc7209a0e05856236300bb3b756519772da600;hp=7a6a25502e8db0e3d3c405765005ec31d1a2c4d8;p=modules%2Fsmesh.git Fixed documentation for Python package (opens in a new window) --- diff --git a/doc/docutils/index.rst b/doc/docutils/index.rst index fece6eff2..4863e8288 100644 --- a/doc/docutils/index.rst +++ b/doc/docutils/index.rst @@ -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 - diff --git a/doc/docutils/overview.rst b/doc/docutils/overview.rst index 5ab13766a..ce82cc812 100644 --- a/doc/docutils/overview.rst +++ b/doc/docutils/overview.rst @@ -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 diff --git a/doc/salome/gui/SMESH/input/index.doc b/doc/salome/gui/SMESH/input/index.doc index 5301ce8de..2522b5bcb 100644 --- a/doc/salome/gui/SMESH/input/index.doc +++ b/doc/salome/gui/SMESH/input/index.doc @@ -26,8 +26,7 @@ array of dedicated operations; 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 salome.smesh python package. \image html image7.jpg "Example of MESH module usage for engineering tasks" diff --git a/doc/salome/gui/SMESH/input/smeshpypkg.doc b/doc/salome/gui/SMESH/input/smeshpypkg.doc deleted file mode 100644 index 06bf94a23..000000000 --- a/doc/salome/gui/SMESH/input/smeshpypkg.doc +++ /dev/null @@ -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 -documentation of the SMESH python packages. - -*/