From d33616d4796bd2fc0a843a59ce8525e7c4ccd417 Mon Sep 17 00:00:00 2001 From: Jean-Philippe ARGAUD Date: Thu, 20 Jun 2013 14:42:53 +0200 Subject: [PATCH] Moving doc files --- configure.ac | 5 +- doc/Makefile.am | 132 +---------------- doc/en/Makefile.am | 148 +++++++++++++++++++ doc/{ => en}/advanced.rst | 0 doc/{ => en}/bibliography.rst | 0 doc/{ => en}/conf.py | 0 doc/{ => en}/examples.rst | 0 doc/{ => en}/glossary.rst | 0 doc/{ => en}/images/ADAO_logo.png | Bin doc/{ => en}/images/adao_activate.png | Bin doc/{ => en}/images/adao_exporttoyacs.png | Bin doc/{ => en}/images/adao_jdcexample01.png | Bin doc/{ => en}/images/adao_jdcexample02.png | Bin doc/{ => en}/images/adao_scriptentry01.png | Bin doc/{ => en}/images/adao_scriptentry02.png | Bin doc/{ => en}/images/adao_viewer.png | Bin doc/{ => en}/images/eficas_close.png | Bin doc/{ => en}/images/eficas_new.png | Bin doc/{ => en}/images/eficas_open.png | Bin doc/{ => en}/images/eficas_save.png | Bin doc/{ => en}/images/eficas_saveas.png | Bin doc/{ => en}/images/eficas_yacs.png | Bin doc/{ => en}/images/yacs_compile.png | Bin doc/{ => en}/images/yacs_containerlog.png | Bin doc/{ => en}/images/yacs_generatedscheme.png | Bin doc/{ => en}/index.rst | 0 doc/{ => en}/intro.rst | 0 doc/{ => en}/licence.rst | 0 doc/{ => en}/reference.rst | 0 doc/{ => en}/resources/ADAO.png | Bin doc/{ => en}/resources/ADAO_large.png | Bin doc/{ => en}/resources/ADAO_small.png | Bin doc/{ => en}/resources/ADAO_small_rouge.png | Bin doc/{ => en}/resources/ADAO_small_vert.png | Bin doc/{ => en}/theory.rst | 0 doc/{ => en}/using.rst | 0 resources/SalomeApp.xml | 2 +- 37 files changed, 155 insertions(+), 132 deletions(-) create mode 100644 doc/en/Makefile.am rename doc/{ => en}/advanced.rst (100%) rename doc/{ => en}/bibliography.rst (100%) rename doc/{ => en}/conf.py (100%) rename doc/{ => en}/examples.rst (100%) rename doc/{ => en}/glossary.rst (100%) rename doc/{ => en}/images/ADAO_logo.png (100%) rename doc/{ => en}/images/adao_activate.png (100%) rename doc/{ => en}/images/adao_exporttoyacs.png (100%) rename doc/{ => en}/images/adao_jdcexample01.png (100%) rename doc/{ => en}/images/adao_jdcexample02.png (100%) rename doc/{ => en}/images/adao_scriptentry01.png (100%) rename doc/{ => en}/images/adao_scriptentry02.png (100%) rename doc/{ => en}/images/adao_viewer.png (100%) rename doc/{ => en}/images/eficas_close.png (100%) rename doc/{ => en}/images/eficas_new.png (100%) rename doc/{ => en}/images/eficas_open.png (100%) rename doc/{ => en}/images/eficas_save.png (100%) rename doc/{ => en}/images/eficas_saveas.png (100%) rename doc/{ => en}/images/eficas_yacs.png (100%) rename doc/{ => en}/images/yacs_compile.png (100%) rename doc/{ => en}/images/yacs_containerlog.png (100%) rename doc/{ => en}/images/yacs_generatedscheme.png (100%) rename doc/{ => en}/index.rst (100%) rename doc/{ => en}/intro.rst (100%) rename doc/{ => en}/licence.rst (100%) rename doc/{ => en}/reference.rst (100%) rename doc/{ => en}/resources/ADAO.png (100%) rename doc/{ => en}/resources/ADAO_large.png (100%) rename doc/{ => en}/resources/ADAO_small.png (100%) rename doc/{ => en}/resources/ADAO_small_rouge.png (100%) rename doc/{ => en}/resources/ADAO_small_vert.png (100%) rename doc/{ => en}/theory.rst (100%) rename doc/{ => en}/using.rst (100%) diff --git a/configure.ac b/configure.ac index 4462c4a..6916b58 100644 --- a/configure.ac +++ b/configure.ac @@ -16,9 +16,9 @@ dnl Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA dnl dnl See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com dnl -dnl Author: André Ribes, andre.ribes@edf.fr, EDF R&D +dnl Author: Jean-Philippe Argaud, jean-philippe.argaud@edf.fr, EDF R&D -AC_INIT(ADAO_SRC, [6.6.0]) +AC_INIT(ADAO_SRC, [7.2.0]) AC_CONFIG_AUX_DIR(adm_local) AM_INIT_AUTOMAKE AM_CONFIG_HEADER(adao_config.h) @@ -135,5 +135,6 @@ AC_CONFIG_FILES([ bin/Makefile bin/qtEficas_adao_study.py doc/Makefile + doc/en/Makefile ]) AC_OUTPUT diff --git a/doc/Makefile.am b/doc/Makefile.am index da70fca..eb8301c 100644 --- a/doc/Makefile.am +++ b/doc/Makefile.am @@ -1,4 +1,4 @@ -# Copyright (C) 2010-2011 EDF R&D +# Copyright (C) 2010-2013 EDF R&D # # This library is free software; you can redistribute it and/or # modify it under the terms of the GNU Lesser General Public @@ -16,132 +16,6 @@ # # See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com # -# Author: André Ribes, andre.ribes@edf.fr, EDF R&D +# Author: Jean-Philippe Argaud, jean-philippe.argaud@edf.fr, EDF R&D -include $(top_srcdir)/adm_local/make_common_starter.am - -# You can set these variables from the command line. -SPHINXOPTS = -SPHINXBUILD = sphinx-build -PAPER = -BUILDDIR = $(top_builddir)/doc/build -SRCDIR = $(top_srcdir)/doc - -EXTRA_DIST = conf.py advanced.rst examples.rst index.rst intro.rst theory.rst using.rst \ - resources/ADAO.png \ - resources/ADAO_small.png \ - resources/ADAO_small_rouge.png \ - resources/ADAO_small_vert.png \ - images/adao_activate.png \ - images/adao_jdcexample01.png \ - images/adao_scriptentry01.png \ - images/adao_viewer.png \ - images/eficas_new.png \ - images/eficas_save.png \ - images/eficas_yacs.png \ - images/yacs_generatedscheme.png \ - images/adao_exporttoyacs.png \ - images/adao_jdcexample02.png \ - images/adao_scriptentry02.png \ - images/eficas_close.png \ - images/eficas_open.png \ - images/eficas_saveas.png \ - images/yacs_containerlog.png - -install-data-local: - make html - ${mkinstalldirs} $(DESTDIR)$(docdir) - ${mkinstalldirs} $(DESTDIR)$(salomeresdir) - cp -R $(BUILDDIR)/html/* $(DESTDIR)$(docdir) - cp $(SRCDIR)/resources/*.png $(DESTDIR)$(salomeresdir) - cp $(SRCDIR)/images/eficas_*.png $(DESTDIR)$(salomeresdir) - -uninstall-local: - chmod -R +w $(DESTDIR)$(docdir) - rm -rf $(DESTDIR)$(docdir) - rm -f $(DESTDIR)$(salomeresdir)/*.png - -clean-local: - -rm -rf $(top_builddir)/doc/build - - -# Internal variables. -PAPEROPT_a4 = -D latex_paper_size=a4 -PAPEROPT_letter = -D latex_paper_size=letter -ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) $(top_srcdir)/doc - -.PHONY: help clean html dirhtml pickle json htmlhelp qthelp latex changes linkcheck doctest - -help: - @echo "Please use \`make ' where is one of" - @echo " html to make standalone HTML files" - @echo " dirhtml to make HTML files named index.html in directories" - @echo " pickle to make pickle files" - @echo " json to make JSON files" - @echo " htmlhelp to make HTML files and a HTML help project" - @echo " qthelp to make HTML files and a qthelp project" - @echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter" - @echo " changes to make an overview of all changed/added/deprecated items" - @echo " linkcheck to check all external links for integrity" - @echo " doctest to run all doctests embedded in the documentation (if enabled)" - -clean: - -rm -rf $(BUILDDIR)/* - -html: - $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html - @echo - @echo "Build finished. The HTML pages are in $(BUILDDIR)/html." - -dirhtml: - $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml - @echo - @echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml." - -pickle: - $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle - @echo - @echo "Build finished; now you can process the pickle files." - -json: - $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json - @echo - @echo "Build finished; now you can process the JSON files." - -htmlhelp: - $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp - @echo - @echo "Build finished; now you can run HTML Help Workshop with the" \ - ".hhp project file in $(BUILDDIR)/htmlhelp." - -qthelp: - $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp - @echo - @echo "Build finished; now you can run "qcollectiongenerator" with the" \ - ".qhcp project file in $(BUILDDIR)/qthelp, like this:" - @echo "# qcollectiongenerator $(BUILDDIR)/qthelp/ADAO.qhcp" - @echo "To view the help file:" - @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/ADAO.qhc" - -latex: - $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex - @echo - @echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex." - @echo "Run \`make all-pdf' or \`make all-ps' in that directory to" \ - "run these through (pdf)latex." - -changes: - $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes - @echo - @echo "The overview file is in $(BUILDDIR)/changes." - -linkcheck: - $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck - @echo - @echo "Link check complete; look for any errors in the above output " \ - "or in $(BUILDDIR)/linkcheck/output.txt." - -doctest: - $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest - @echo "Testing of doctests in the sources finished, look at the " \ - "results in $(BUILDDIR)/doctest/output.txt." +SUBDIRS = en diff --git a/doc/en/Makefile.am b/doc/en/Makefile.am new file mode 100644 index 0000000..e531baf --- /dev/null +++ b/doc/en/Makefile.am @@ -0,0 +1,148 @@ +# Copyright (C) 2010-2013 EDF R&D +# +# This library is free software; you can redistribute it and/or +# modify it under the terms of the GNU Lesser General Public +# License as published by the Free Software Foundation; either +# version 2.1 of the License. +# +# This library is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +# Lesser General Public License for more details. +# +# You should have received a copy of the GNU Lesser General Public +# License along with this library; if not, write to the Free Software +# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA +# +# See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com +# +# Author: Jean-Philippe Argaud, jean-philippe.argaud@edf.fr, EDF R&D + +include $(top_srcdir)/adm_local/make_common_starter.am + +# You can set these variables from the command line. +DOCLANG = en +SPHINXOPTS = +SPHINXBUILD = sphinx-build +PAPER = +BUILDDIR = $(top_builddir)/doc/build/$(DOCLANG) +SRCDIR = $(top_srcdir)/doc/$(DOCLANG) + +EXTRA_DIST = conf.py advanced.rst examples.rst index.rst intro.rst theory.rst using.rst \ + resources/ADAO.png \ + resources/ADAO_small.png \ + resources/ADAO_small_rouge.png \ + resources/ADAO_small_vert.png \ + images/adao_activate.png \ + images/adao_jdcexample01.png \ + images/adao_scriptentry01.png \ + images/adao_viewer.png \ + images/eficas_new.png \ + images/eficas_save.png \ + images/eficas_yacs.png \ + images/yacs_generatedscheme.png \ + images/adao_exporttoyacs.png \ + images/adao_jdcexample02.png \ + images/adao_scriptentry02.png \ + images/eficas_close.png \ + images/eficas_open.png \ + images/eficas_saveas.png \ + images/yacs_containerlog.png + +install-data-local: + make html + ${mkinstalldirs} $(DESTDIR)$(docdir)/$(DOCLANG) + ${mkinstalldirs} $(DESTDIR)$(salomeresdir) + cp -R $(BUILDDIR)/html/* $(DESTDIR)$(docdir)/$(DOCLANG) + cp $(SRCDIR)/resources/*.png $(DESTDIR)$(salomeresdir) + cp $(SRCDIR)/images/eficas_*.png $(DESTDIR)$(salomeresdir) + +uninstall-local: + chmod -R +w $(DESTDIR)$(docdir)/$(DOCLANG) + rm -rf $(DESTDIR)$(docdir) + rm -f $(DESTDIR)$(salomeresdir)/*.png + +clean-local: + -rm -rf $(BUILDDIR) + + +# Internal variables. +PAPEROPT_a4 = -D latex_paper_size=a4 +PAPEROPT_letter = -D latex_paper_size=letter +ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) $(SRCDIR) + +.PHONY: help clean html dirhtml pickle json htmlhelp qthelp latex changes linkcheck doctest + +help: + @echo "Please use \`make ' where is one of" + @echo " html to make standalone HTML files" + @echo " dirhtml to make HTML files named index.html in directories" + @echo " pickle to make pickle files" + @echo " json to make JSON files" + @echo " htmlhelp to make HTML files and a HTML help project" + @echo " qthelp to make HTML files and a qthelp project" + @echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter" + @echo " changes to make an overview of all changed/added/deprecated items" + @echo " linkcheck to check all external links for integrity" + @echo " doctest to run all doctests embedded in the documentation (if enabled)" + +clean: + -rm -rf $(BUILDDIR)/* + +html: + $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html + @echo + @echo "Build finished. The HTML pages are in $(BUILDDIR)/html." + +dirhtml: + $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml + @echo + @echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml." + +pickle: + $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle + @echo + @echo "Build finished; now you can process the pickle files." + +json: + $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json + @echo + @echo "Build finished; now you can process the JSON files." + +htmlhelp: + $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp + @echo + @echo "Build finished; now you can run HTML Help Workshop with the" \ + ".hhp project file in $(BUILDDIR)/htmlhelp." + +qthelp: + $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp + @echo + @echo "Build finished; now you can run "qcollectiongenerator" with the" \ + ".qhcp project file in $(BUILDDIR)/qthelp, like this:" + @echo "# qcollectiongenerator $(BUILDDIR)/qthelp/ADAO.qhcp" + @echo "To view the help file:" + @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/ADAO.qhc" + +latex: + $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex + @echo + @echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex." + @echo "Run \`make all-pdf' or \`make all-ps' in that directory to" \ + "run these through (pdf)latex." + +changes: + $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes + @echo + @echo "The overview file is in $(BUILDDIR)/changes." + +linkcheck: + $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck + @echo + @echo "Link check complete; look for any errors in the above output " \ + "or in $(BUILDDIR)/linkcheck/output.txt." + +doctest: + $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest + @echo "Testing of doctests in the sources finished, look at the " \ + "results in $(BUILDDIR)/doctest/output.txt." diff --git a/doc/advanced.rst b/doc/en/advanced.rst similarity index 100% rename from doc/advanced.rst rename to doc/en/advanced.rst diff --git a/doc/bibliography.rst b/doc/en/bibliography.rst similarity index 100% rename from doc/bibliography.rst rename to doc/en/bibliography.rst diff --git a/doc/conf.py b/doc/en/conf.py similarity index 100% rename from doc/conf.py rename to doc/en/conf.py diff --git a/doc/examples.rst b/doc/en/examples.rst similarity index 100% rename from doc/examples.rst rename to doc/en/examples.rst diff --git a/doc/glossary.rst b/doc/en/glossary.rst similarity index 100% rename from doc/glossary.rst rename to doc/en/glossary.rst diff --git a/doc/images/ADAO_logo.png b/doc/en/images/ADAO_logo.png similarity index 100% rename from doc/images/ADAO_logo.png rename to doc/en/images/ADAO_logo.png diff --git a/doc/images/adao_activate.png b/doc/en/images/adao_activate.png similarity index 100% rename from doc/images/adao_activate.png rename to doc/en/images/adao_activate.png diff --git a/doc/images/adao_exporttoyacs.png b/doc/en/images/adao_exporttoyacs.png similarity index 100% rename from doc/images/adao_exporttoyacs.png rename to doc/en/images/adao_exporttoyacs.png diff --git a/doc/images/adao_jdcexample01.png b/doc/en/images/adao_jdcexample01.png similarity index 100% rename from doc/images/adao_jdcexample01.png rename to doc/en/images/adao_jdcexample01.png diff --git a/doc/images/adao_jdcexample02.png b/doc/en/images/adao_jdcexample02.png similarity index 100% rename from doc/images/adao_jdcexample02.png rename to doc/en/images/adao_jdcexample02.png diff --git a/doc/images/adao_scriptentry01.png b/doc/en/images/adao_scriptentry01.png similarity index 100% rename from doc/images/adao_scriptentry01.png rename to doc/en/images/adao_scriptentry01.png diff --git a/doc/images/adao_scriptentry02.png b/doc/en/images/adao_scriptentry02.png similarity index 100% rename from doc/images/adao_scriptentry02.png rename to doc/en/images/adao_scriptentry02.png diff --git a/doc/images/adao_viewer.png b/doc/en/images/adao_viewer.png similarity index 100% rename from doc/images/adao_viewer.png rename to doc/en/images/adao_viewer.png diff --git a/doc/images/eficas_close.png b/doc/en/images/eficas_close.png similarity index 100% rename from doc/images/eficas_close.png rename to doc/en/images/eficas_close.png diff --git a/doc/images/eficas_new.png b/doc/en/images/eficas_new.png similarity index 100% rename from doc/images/eficas_new.png rename to doc/en/images/eficas_new.png diff --git a/doc/images/eficas_open.png b/doc/en/images/eficas_open.png similarity index 100% rename from doc/images/eficas_open.png rename to doc/en/images/eficas_open.png diff --git a/doc/images/eficas_save.png b/doc/en/images/eficas_save.png similarity index 100% rename from doc/images/eficas_save.png rename to doc/en/images/eficas_save.png diff --git a/doc/images/eficas_saveas.png b/doc/en/images/eficas_saveas.png similarity index 100% rename from doc/images/eficas_saveas.png rename to doc/en/images/eficas_saveas.png diff --git a/doc/images/eficas_yacs.png b/doc/en/images/eficas_yacs.png similarity index 100% rename from doc/images/eficas_yacs.png rename to doc/en/images/eficas_yacs.png diff --git a/doc/images/yacs_compile.png b/doc/en/images/yacs_compile.png similarity index 100% rename from doc/images/yacs_compile.png rename to doc/en/images/yacs_compile.png diff --git a/doc/images/yacs_containerlog.png b/doc/en/images/yacs_containerlog.png similarity index 100% rename from doc/images/yacs_containerlog.png rename to doc/en/images/yacs_containerlog.png diff --git a/doc/images/yacs_generatedscheme.png b/doc/en/images/yacs_generatedscheme.png similarity index 100% rename from doc/images/yacs_generatedscheme.png rename to doc/en/images/yacs_generatedscheme.png diff --git a/doc/index.rst b/doc/en/index.rst similarity index 100% rename from doc/index.rst rename to doc/en/index.rst diff --git a/doc/intro.rst b/doc/en/intro.rst similarity index 100% rename from doc/intro.rst rename to doc/en/intro.rst diff --git a/doc/licence.rst b/doc/en/licence.rst similarity index 100% rename from doc/licence.rst rename to doc/en/licence.rst diff --git a/doc/reference.rst b/doc/en/reference.rst similarity index 100% rename from doc/reference.rst rename to doc/en/reference.rst diff --git a/doc/resources/ADAO.png b/doc/en/resources/ADAO.png similarity index 100% rename from doc/resources/ADAO.png rename to doc/en/resources/ADAO.png diff --git a/doc/resources/ADAO_large.png b/doc/en/resources/ADAO_large.png similarity index 100% rename from doc/resources/ADAO_large.png rename to doc/en/resources/ADAO_large.png diff --git a/doc/resources/ADAO_small.png b/doc/en/resources/ADAO_small.png similarity index 100% rename from doc/resources/ADAO_small.png rename to doc/en/resources/ADAO_small.png diff --git a/doc/resources/ADAO_small_rouge.png b/doc/en/resources/ADAO_small_rouge.png similarity index 100% rename from doc/resources/ADAO_small_rouge.png rename to doc/en/resources/ADAO_small_rouge.png diff --git a/doc/resources/ADAO_small_vert.png b/doc/en/resources/ADAO_small_vert.png similarity index 100% rename from doc/resources/ADAO_small_vert.png rename to doc/en/resources/ADAO_small_vert.png diff --git a/doc/theory.rst b/doc/en/theory.rst similarity index 100% rename from doc/theory.rst rename to doc/en/theory.rst diff --git a/doc/using.rst b/doc/en/using.rst similarity index 100% rename from doc/using.rst rename to doc/en/using.rst diff --git a/resources/SalomeApp.xml b/resources/SalomeApp.xml index d0dda0e..0fc539e 100644 --- a/resources/SalomeApp.xml +++ b/resources/SalomeApp.xml @@ -34,6 +34,6 @@
- +
-- 2.39.2