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"
# 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
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
| |
+---------------------------------------------------------------+
-Methods of the class cas
-"""""""""""""""""""""""""
+Methods of both classes cas and iteration
+"""""""""""""""""""""""""""""""""""""""""
+---------------------------------------------------------------+
+---------------------------------------------------------------+
| |
| **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. |
| |
+---------------------------------------------------------------+
+---------------------------------------------------------------+
+---------------------------------------------------------------+
-| .. 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)** |
| **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)** |
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"
# 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
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
| |
+---------------------------------------------------------------+
-Méthodes de la classe cas
-"""""""""""""""""""""""""
+Méthodes communes aux classes cas et iteration
+""""""""""""""""""""""""""""""""""""""""""""""
+---------------------------------------------------------------+
+---------------------------------------------------------------+
| |
| **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. |
| |
+---------------------------------------------------------------+
+---------------------------------------------------------------+
+---------------------------------------------------------------+
-| .. 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)** |
| **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)** |