]> SALOME platform Git repositories - modules/homard.git/commitdiff
Salome HOME
simplification
authornicolas <nicolas>
Tue, 25 Jun 2013 12:13:00 +0000 (12:13 +0000)
committernicolas <nicolas>
Tue, 25 Jun 2013 12:13:00 +0000 (12:13 +0000)
doc/en/Makefile.am
doc/en/conf.py.in
doc/en/tui_create_iteration.rst
doc/fr/Makefile.am
doc/fr/conf.py.in
doc/fr/tui_create_iteration.rst

index ae1dfb8581b2ab23b79b84a23f52ee84d4fe788d..cd6ef89e3ae5beecffc51bb53a79d67b850f0d59 100644 (file)
@@ -34,21 +34,20 @@ endif
 
 homarddocdir=$(docdir)/gui/HOMARD/$(homarddoc_langue)
 
-SPHINXOPTS      =
-SOURCEDIR       = $(srcdir)
-SPHINXBUILD     = sphinx-build
-PAPEROPT_a4     = -D latex_paper_size=a4
-ALLSPHINXOPTS   = -d doctrees $(PAPEROPT_a4) $(SPHINXOPTS) $(SOURCEDIR)
+SPHINXOPTS  =
+SPHINXBUILD = sphinx-build
 
 htm:
-       mkdir -p html doctrees
-       $(SPHINXBUILD) -c $(top_builddir)/doc/$(homarddoc_langue) -b html $(ALLSPHINXOPTS) html
+#      mkdir -p html doctrees
+       mkdir -p html
+       $(SPHINXBUILD) $(SPHINXOPTS) -c $(top_builddir)/doc/$(homarddoc_langue) -b html $(srcdir) html
        @echo
        @echo "Build finished. The HTML pages are in html."
 
 latex:
-       mkdir -p latex doctrees
-       $(SPHINXBUILD) -c $(top_builddir)/doc/$(homarddoc_langue) -b latex $(ALLSPHINXOPTS) latex
+#      mkdir -p latex doctrees
+       mkdir -p latex
+       $(SPHINXBUILD) $(SPHINXOPTS) -c $(top_builddir)/doc/$(homarddoc_langue) -b latex $(srcdir) latex
        @echo
        @echo "Build finished. The pages are in latex."
        @echo "Go into latex and apply twice : pdflatex HOMARD.tex to produce HOMARD.pdf"
index 9926940ad9fa195d443b65c97dabbe5e06fcb0b8..cf8cfbb9ad5fbdc138d2e1de6265a2d149bec6a9 100644 (file)
@@ -64,7 +64,7 @@ language = 'en'
 
 # List of directories, relative to source directory, that shouldn't be searched
 # for source files.
-exclude_trees = ['_build','ref','images','CVS']
+exclude_trees = ['_build','ref','images','CVS','.svn']
 
 # The reST default role (used for this markup: `text`) to use for all documents.
 #default_role = None
@@ -147,7 +147,7 @@ html_use_index = True
 html_split_index = False
 
 # If true, the reST sources are included in the HTML build as _sources/<name>.
-html_copy_source = True
+html_copy_source = False
 
 # If true, links to the reST sources are added to the pages.
 #html_show_sourcelink = True
index b8e22594608d35b4afc3bde0ebf5b2e1f936dd67..74e909f909a0dc5a6a87baf210adc7d712fcbc62 100644 (file)
@@ -30,8 +30,8 @@ Methods of the class homard
 |                                                               |
 +---------------------------------------------------------------+
 
-Methods of the class cas
-"""""""""""""""""""""""""
+Methods of both classes cas and iteration
+"""""""""""""""""""""""""""""""""""""""""
 
 +---------------------------------------------------------------+
 +---------------------------------------------------------------+
@@ -39,23 +39,29 @@ Methods of the class cas
 |                                                               |
 | **NextIteration(iter_name)**                                  |
 |     Returns an instance of the class ``iteration`` after      |
-|     its creation: it is the next iteration after the very     |
-|     first one that corresponds to the first mesh of the case  |
+|     its creation. It is the next iteration after:             |
 |                                                               |
-|     - ``iter_name``: the name of this next iteration          |
+|     - for a case: the very first one that corresponds to the  |
+|       first mesh of the case                                  |
+|     - for an iteration: the current iteration                 |
 |                                                               |
-| Default:                                                      |
+| Default:  the produced mesh has got the same name as the      |
+| iteration                                                     |
 |                                                               |
-|  * the produced mesh has got the same name as the iteration   |
+|     - ``iter_name``: the name of this next iteration          |
 +---------------------------------------------------------------+
 | .. module:: LastIteration                                     |
 |                                                               |
 | **LastIteration()**                                           |
-|     Returns an instance of the class ``iteration``: the last  |
-|     iteration into the descendants of the initial iteration   |
-|     of the case. It is the one that has got no child. There is|
-|     an error if more than one branch exists into the          |
-|     descendants.                                              |
+|     Returns an instance of the class ``iteration`` that is    |
+|     the last iteration into the descendants of:               |
+|                                                               |
+|     - for a case: the very first one that corresponds to the  |
+|       first mesh of the case                                  |
+|     - for an iteration: the current iteration                 |
+|                                                               |
+|     It is the one that has got no child. There is an error if |
+|     more than one branch exists into the descendants.         |
 |                                                               |
 +---------------------------------------------------------------+
 
@@ -67,19 +73,6 @@ General methods
 
 +---------------------------------------------------------------+
 +---------------------------------------------------------------+
-| .. module:: NextIteration                                     |
-|                                                               |
-| **NextIteration(iter_name)**                                  |
-|     Returns an instance of the class ``iteration`` after      |
-|     its creation: it is the next iteration after the current  |
-|     one                                                       |
-|                                                               |
-|     - ``iter_name``: the name of this next iteration          |
-|                                                               |
-| Default:                                                      |
-|                                                               |
-|  * the produced mesh has got the same name as the iteration   |
-+---------------------------------------------------------------+
 | .. module:: Compute                                           |
 |                                                               |
 | **Compute(option1, option2)**                                 |
@@ -120,15 +113,6 @@ General methods
 | **GetIterParent()**                                           |
 |     Returns the iteration parent                              |
 +---------------------------------------------------------------+
-| .. module:: LastIteration                                     |
-|                                                               |
-| **LastIteration()**                                           |
-|     Returns an instance of the class ``iteration``: the last  |
-|     iteration into the descendants of the current iteration.  |
-|     It is the one that has got no child. There is             |
-|     an error if more than one branch exists into the          |
-|     descendants.                                              |
-+---------------------------------------------------------------+
 | .. module:: AssociateHypo                                     |
 |                                                               |
 | **AssociateHypo(hypo_name)**                                  |
index a87a162ec691b70bccbfb470b6953b538b41f2a2..e13629169f95903ca37ef062ca421e4d2abd9863 100644 (file)
@@ -34,21 +34,20 @@ endif
 
 homarddocdir=$(docdir)/gui/HOMARD/$(homarddoc_langue)
 
-SPHINXOPTS      =
-SOURCEDIR       = $(srcdir)
-SPHINXBUILD     = sphinx-build
-PAPEROPT_a4     = -D latex_paper_size=a4
-ALLSPHINXOPTS   = -d doctrees $(PAPEROPT_a4) $(SPHINXOPTS) $(SOURCEDIR)
+SPHINXOPTS  =
+SPHINXBUILD = sphinx-build
 
 htm:
-       mkdir -p html doctrees
-       $(SPHINXBUILD) -c $(top_builddir)/doc/$(homarddoc_langue) -b html $(ALLSPHINXOPTS) html
+#      mkdir -p html doctrees
+       mkdir -p html
+       $(SPHINXBUILD) $(SPHINXOPTS) -c $(top_builddir)/doc/$(homarddoc_langue) -b html $(srcdir) html
        @echo
        @echo "Build fini. Les pages HTML sont dans html."
 
 latex:
-       mkdir -p latex doctrees
-       $(SPHINXBUILD) -c $(top_builddir)/doc/$(homarddoc_langue) -b latex $(ALLSPHINXOPTS) latex
+#      mkdir -p latex doctrees
+       mkdir -p latex
+       $(SPHINXBUILD) $(SPHINXOPTS) -c $(top_builddir)/doc/$(homarddoc_langue) -b latex $(srcdir) latex
        @echo
        @echo "Build fini. Les pages sont en latex."
        @echo "Aller dans latex et appliquer deux fois : pdflatex HOMARD.tex pour produire HOMARD.pdf"
index 1bd952b928d193ae7d3d2cb84a35359f91ecf118..f2f51182612ac6631838ae8f52b7fced59a86f4c 100644 (file)
@@ -64,7 +64,7 @@ language = 'fr'
 
 # List of directories, relative to source directory, that shouldn't be searched
 # for source files.
-exclude_trees = ['_build','ref','images','CVS']
+exclude_trees = ['_build','ref','images','CVS','.svn']
 
 # The reST default role (used for this markup: `text`) to use for all documents.
 #default_role = None
@@ -149,7 +149,7 @@ html_use_index = True
 html_split_index = False
 
 # If true, the reST sources are included in the HTML build as _sources/<name>.
-html_copy_source = True
+html_copy_source = False
 
 # If true, links to the reST sources are added to the pages.
 #html_show_sourcelink = True
index 33f89f629098e1cbb9af87b841fbb1c8ae8ad396..bafdd62b0ef7e3a153c92250af972774258f0d19 100644 (file)
@@ -29,8 +29,8 @@ M
 |                                                               |
 +---------------------------------------------------------------+
 
-Méthodes de la classe cas
-"""""""""""""""""""""""""
+Méthodes communes aux classes cas et iteration
+""""""""""""""""""""""""""""""""""""""""""""""
 
 +---------------------------------------------------------------+
 +---------------------------------------------------------------+
@@ -38,22 +38,27 @@ M
 |                                                               |
 | **NextIteration(iter_name)**                                  |
 |     Retourne une instance de la classe ``iteration`` après    |
-|     sa création : elle suit immédiatement l'itération         |
-|     initiale, correspondant au maillage définissant le cas    |
+|     sa création. Elle suit immédiatement :                    |
 |                                                               |
-|     - ``iter_name`` : le nom à donner à la nouvelle itération |
+|     - pour un cas : l'itération initiale, correspondant au    |
+|       maillage définissant le cas                             |
+|     - pour une itération : l'itération courante               |
 |                                                               |
-| Par défaut :                                                  |
+| Par défaut, le maillage produit a le même nom que l'itération |
 |                                                               |
-|  * le maillage produit a le même nom que l'itération          |
+|     - ``iter_name`` : le nom à donner à la nouvelle itération |
 +---------------------------------------------------------------+
 | .. module:: LastIteration                                     |
 |                                                               |
 | **LastIteration()**                                           |
-|     Retourne une instance de la classe ``iteration`` : la     |
-|     dernière créée dans la descendance de l'itération initiale|
-|     du cas. C'est celle qui est sans fille. Il y a erreur s'il|
-|     existe plus d'une branche dans la descendance.            |
+|     Retourne une instance de la classe ``iteration``. C'est   |
+|     la dernière créée dans la descendance de :                |
+|                                                               |
+|     - pour un cas : l'itération initiale du cas               |
+|     - pour une itération : l'itération courante               |
+|                                                               |
+|     C'est celle qui est sans fille. Il y a erreur s'il existe |
+|     plus d'une branche dans la descendance.                   |
 |                                                               |
 +---------------------------------------------------------------+
 
@@ -65,18 +70,6 @@ G
 
 +---------------------------------------------------------------+
 +---------------------------------------------------------------+
-| .. module:: NextIteration                                     |
-|                                                               |
-| **NextIteration(iter_name)**                                  |
-|     Retourne une instance de la classe ``iteration`` qui suit |
-|     l'itération courante                                      |
-|                                                               |
-|     - ``iter_name`` : le nom à donner à la nouvelle itération |
-|                                                               |
-| Par défaut :                                                  |
-|                                                               |
-|  * le maillage produit a le même nom que l'itération          |
-+---------------------------------------------------------------+
 | .. module:: Compute                                           |
 |                                                               |
 | **Compute(option1, option2)**                                 |
@@ -117,14 +110,6 @@ G
 | **GetIterParent()**                                           |
 |     Retourne l'itération mère                                 |
 +---------------------------------------------------------------+
-| .. module:: LastIteration                                     |
-|                                                               |
-| **LastIteration()**                                           |
-|     Retourne une instance de la classe ``iteration`` : la     |
-|     dernière créée dans la descendance de l'itération. C'est  |
-|     celle qui est sans fille. Il y a erreur s'il existe plus  |
-|     d'une branche dans la descendance.                        |
-+---------------------------------------------------------------+
 | .. module:: AssociateHypo                                     |
 |                                                               |
 | **AssociateHypo(hypo_name)**                                  |