From 4ab4dce5b5f8d4f5e255294d649acda8411fecf2 Mon Sep 17 00:00:00 2001 From: nicolas Date: Tue, 25 Jun 2013 12:13:00 +0000 Subject: [PATCH] simplification --- doc/en/Makefile.am | 17 +++++------ doc/en/conf.py.in | 4 +-- doc/en/tui_create_iteration.rst | 52 ++++++++++++--------------------- doc/fr/Makefile.am | 17 +++++------ doc/fr/conf.py.in | 4 +-- doc/fr/tui_create_iteration.rst | 47 ++++++++++------------------- 6 files changed, 54 insertions(+), 87 deletions(-) diff --git a/doc/en/Makefile.am b/doc/en/Makefile.am index ae1dfb85..cd6ef89e 100644 --- a/doc/en/Makefile.am +++ b/doc/en/Makefile.am @@ -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" diff --git a/doc/en/conf.py.in b/doc/en/conf.py.in index 9926940a..cf8cfbb9 100644 --- a/doc/en/conf.py.in +++ b/doc/en/conf.py.in @@ -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/. -html_copy_source = True +html_copy_source = False # If true, links to the reST sources are added to the pages. #html_show_sourcelink = True diff --git a/doc/en/tui_create_iteration.rst b/doc/en/tui_create_iteration.rst index b8e22594..74e909f9 100644 --- a/doc/en/tui_create_iteration.rst +++ b/doc/en/tui_create_iteration.rst @@ -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)** | diff --git a/doc/fr/Makefile.am b/doc/fr/Makefile.am index a87a162e..e1362916 100644 --- a/doc/fr/Makefile.am +++ b/doc/fr/Makefile.am @@ -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" diff --git a/doc/fr/conf.py.in b/doc/fr/conf.py.in index 1bd952b9..f2f51182 100644 --- a/doc/fr/conf.py.in +++ b/doc/fr/conf.py.in @@ -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/. -html_copy_source = True +html_copy_source = False # If true, links to the reST sources are added to the pages. #html_show_sourcelink = True diff --git a/doc/fr/tui_create_iteration.rst b/doc/fr/tui_create_iteration.rst index 33f89f62..bafdd62b 100644 --- a/doc/fr/tui_create_iteration.rst +++ b/doc/fr/tui_create_iteration.rst @@ -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)** | -- 2.39.2