From b29cf9a6787a9e979d1058403240a607ed542adb Mon Sep 17 00:00:00 2001 From: Paul RASCLE Date: Mon, 21 Dec 2015 17:48:39 +0100 Subject: [PATCH] generation pdf tutoriel, procedure manuelle --- doc/salome/tutorial/CMakeLists.txt | 24 +- .../tutorial/_static/vtk_view_fitall.png | Bin doc/salome/tutorial/_static/vtk_view_top.png | Bin doc/salome/tutorial/conf.py.in | 27 ++- doc/salome/tutorial/interpolationZ.rst | 4 +- doc/salome/tutorial/local/Makefile | 153 ++++++++++++ doc/salome/tutorial/local/conf.py | 217 ++++++++++++++++++ doc/salome/tutorial/preliminaires.rst | 1 + 8 files changed, 402 insertions(+), 24 deletions(-) mode change 100755 => 100644 doc/salome/tutorial/_static/vtk_view_fitall.png mode change 100755 => 100644 doc/salome/tutorial/_static/vtk_view_top.png create mode 100644 doc/salome/tutorial/local/Makefile create mode 100644 doc/salome/tutorial/local/conf.py diff --git a/doc/salome/tutorial/CMakeLists.txt b/doc/salome/tutorial/CMakeLists.txt index b5bfa74f..30b13cfc 100644 --- a/doc/salome/tutorial/CMakeLists.txt +++ b/doc/salome/tutorial/CMakeLists.txt @@ -48,27 +48,21 @@ SET(ALLSPHINXOPTS -d doctrees ${PAPEROPT_a4} ${SPHINXOPTS} ${SOURCEDIR}) SALOME_CONFIGURE_FILE(conf.py.in conf.py) -SET(HTML_ROOT_FILE html/index.html) - -ADD_CUSTOM_COMMAND(OUTPUT ${HTML_ROOT_FILE} +ADD_CUSTOM_TARGET(BUILD_HTML ALL COMMAND ${CMAKE_COMMAND} -E make_directory html COMMAND ${CMAKE_COMMAND} -E make_directory doctrees COMMAND ${SPHINX_EXECUTABLE} -c ${CMAKE_BINARY_DIR}/doc/salome/tutorial -b html ${ALLSPHINXOPTS} html DEPENDS ${RSTFILES} WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR} ) - -SET(PDF_ROOT_FILE latex/Makefile) - -ADD_CUSTOM_COMMAND(OUTPUT ${PDF_ROOT_FILE} - COMMAND ${CMAKE_COMMAND} -E make_directory latex - COMMAND ${SPHINX_EXECUTABLE} -c ${CMAKE_BINARY_DIR}/doc/salome/tutorial -b latex ${ALLSPHINXOPTS} latex - COMMAND make -C latex all-pdf - DEPENDS ${RSTFILES} - WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR} -) - -ADD_CUSTOM_TARGET(BUILD_HTML ALL DEPENDS ${PDF_ROOT_FILE} ${HTML_ROOT_FILE}) + +# ADD_CUSTOM_TARGET(BUILD_PDF ALL +# COMMAND ${CMAKE_COMMAND} -E make_directory latex +# COMMAND ${SPHINX_EXECUTABLE} -c ${CMAKE_BINARY_DIR}/doc/salome/tutorial -b latex ${ALLSPHINXOPTS} latex +# COMMAND make -C latex all-pdf +# DEPENDS ${RSTFILES} +# WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR} +# ) INSTALL(DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}/html/ DESTINATION ${SALOME_INSTALL_DOC}/gui/HYDRO_tutorial diff --git a/doc/salome/tutorial/_static/vtk_view_fitall.png b/doc/salome/tutorial/_static/vtk_view_fitall.png old mode 100755 new mode 100644 diff --git a/doc/salome/tutorial/_static/vtk_view_top.png b/doc/salome/tutorial/_static/vtk_view_top.png old mode 100755 new mode 100644 diff --git a/doc/salome/tutorial/conf.py.in b/doc/salome/tutorial/conf.py.in index b43e1a50..be103a76 100644 --- a/doc/salome/tutorial/conf.py.in +++ b/doc/salome/tutorial/conf.py.in @@ -41,6 +41,7 @@ import sys, os # Add any Sphinx extension module names here, as strings. They can be extensions # coming with Sphinx (named 'sphinx.ext.*') or your custom ones. #extensions = ['sphinx.ext.extlinks'] +extensions = ['sphinx.ext.viewcode','sphinx.ext.pngmath'] # Add any paths that contain templates here, relative to this directory. #templates_path = ['_templates'] @@ -56,16 +57,18 @@ master_doc = 'index' # General information about the project. project = u'HYDRO module' -copyright = u'2012-2013, EDF' +copyright = u'2015-2016, EDF' # The version info for the project you're documenting, acts as replacement for # |version| and |release|, also used in various other places throughout the # built documents. # # The short X.Y version. -version = '@SALOMEHYDRO_VERSION@' +#version = '@SALOMEHYDRO_VERSION@' +version = 'V7_6' # The full version, including alpha/beta/rc tags. -release = '@SALOMEHYDRO_VERSION@' +#release = '@SALOMEHYDRO_VERSION@' +release = 'V7_6-2015.12.18' # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. @@ -181,18 +184,24 @@ html_static_path = ['_static'] # -- Options for LaTeX output -------------------------------------------------- +latex_elements = { # The paper size ('letter' or 'a4'). -#latex_paper_size = 'letter' +#latex_paper_size = 'a4' +'papersize': 'a4paper', # The font size ('10pt', '11pt' or '12pt'). #latex_font_size = '10pt' +# Latex figure (float) alignment +'figure_align': 'htbp', +} + # Grouping the document tree into LaTeX files. List of tuples # (source start file, target name, title, author, documentclass [howto/manual]). -#latex_documents = [ -# ('index', 'HYDROmodule.tex', u'HYDRO module Documentation', -# u'EDF R&D', 'manual'), -#] +latex_documents = [ + ('index', 'HYDROmodule.tex', u'HYDRO module Documentation', + u'EDF RD', 'manual'), +] # The name of an image file (relative to this directory) to place at the top of # the title page. @@ -204,6 +213,8 @@ html_static_path = ['_static'] # Additional stuff for the LaTeX preamble. #latex_preamble = '' +latex_preamble = """\usepackage{pdfpages} +\setcounter{tocdepth}{2}""" # Documents to append as an appendix to all manuals. #latex_appendices = [] diff --git a/doc/salome/tutorial/interpolationZ.rst b/doc/salome/tutorial/interpolationZ.rst index c80941d6..0799de2a 100644 --- a/doc/salome/tutorial/interpolationZ.rst +++ b/doc/salome/tutorial/interpolationZ.rst @@ -45,7 +45,9 @@ Calcul de l'interpolation en Z aux noeuds du maillage La constitution du champ d'altitude se fait au moyen d'un script Python, qu'il faut editer, puis exécuter. -Voici le script:: +Voici le script : + +:: # -*- coding: utf-8 -*- diff --git a/doc/salome/tutorial/local/Makefile b/doc/salome/tutorial/local/Makefile new file mode 100644 index 00000000..150a3f23 --- /dev/null +++ b/doc/salome/tutorial/local/Makefile @@ -0,0 +1,153 @@ +# Makefile for Sphinx documentation +# + +# You can set these variables from the command line. +SPHINXOPTS = +SPHINXBUILD = sphinx-build +PAPER = +BUILDDIR = build + +# Internal variables. +PAPEROPT_a4 = -D latex_paper_size=a4 +PAPEROPT_letter = -D latex_paper_size=letter +ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees -c . $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .. +# the i18n builder cannot share the environment and doctrees with the others +I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .. + +.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext + +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 " singlehtml to make a single large HTML file" + @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 " devhelp to make HTML files and a Devhelp project" + @echo " epub to make an epub" + @echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter" + @echo " latexpdf to make LaTeX files and run them through pdflatex" + @echo " text to make text files" + @echo " man to make manual pages" + @echo " texinfo to make Texinfo files" + @echo " info to make Texinfo files and run them through makeinfo" + @echo " gettext to make PO message catalogs" + @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." + +singlehtml: + $(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml + @echo + @echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml." + +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/Formation_1.qhcp" + @echo "To view the help file:" + @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/Formation_1.qhc" + +devhelp: + $(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp + @echo + @echo "Build finished." + @echo "To view the help file:" + @echo "# mkdir -p $$HOME/.local/share/devhelp/Formation_1" + @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/Formation_1" + @echo "# devhelp" + +epub: + $(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub + @echo + @echo "Build finished. The epub file is in $(BUILDDIR)/epub." + +latex: + $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex + @echo + @echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex." + @echo "Run \`make' in that directory to run these through (pdf)latex" \ + "(use \`make latexpdf' here to do that automatically)." + +latexpdf: + $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex + @echo "Running LaTeX files through pdflatex..." + $(MAKE) -C $(BUILDDIR)/latex all-pdf + @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex." + +text: + $(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text + @echo + @echo "Build finished. The text files are in $(BUILDDIR)/text." + +man: + $(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man + @echo + @echo "Build finished. The manual pages are in $(BUILDDIR)/man." + +texinfo: + $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo + @echo + @echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo." + @echo "Run \`make' in that directory to run these through makeinfo" \ + "(use \`make info' here to do that automatically)." + +info: + $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo + @echo "Running Texinfo files through makeinfo..." + make -C $(BUILDDIR)/texinfo info + @echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo." + +gettext: + $(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale + @echo + @echo "Build finished. The message catalogs are in $(BUILDDIR)/locale." + +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/salome/tutorial/local/conf.py b/doc/salome/tutorial/local/conf.py new file mode 100644 index 00000000..36764bcd --- /dev/null +++ b/doc/salome/tutorial/local/conf.py @@ -0,0 +1,217 @@ +# -*- coding: utf-8 -*- +# +# Formation SALOME Module 1 documentation build configuration file, created by +# sphinx-quickstart on Fri Jul 25 14:29:29 2014. +# +# This file is execfile()d with the current directory set to its containing dir. +# +# Note that not all possible configuration values are present in this +# autogenerated file. +# +# All configuration values have a default; values that are commented out +# serve to show the default. + +import sys, os + +# If extensions (or modules to document with autodoc) are in another directory, +# add these directories to sys.path here. If the directory is relative to the +# documentation root, use os.path.abspath to make it absolute, like shown here. +#sys.path.insert(0, os.path.abspath('.')) + +# -- General configuration ----------------------------------------------------- + +# If your documentation needs a minimal Sphinx version, state it here. +#needs_sphinx = '1.0' + +# Add any Sphinx extension module names here, as strings. They can be extensions +# coming with Sphinx (named 'sphinx.ext.*') or your custom ones. +extensions = ['sphinx.ext.viewcode','sphinx.ext.pngmath']#,'sphinx.ext.graphviz'] + +# Add any paths that contain templates here, relative to this directory. +templates_path = ['_templates'] + +# The suffix of source filenames. +source_suffix = '.rst' + +# The encoding of source files. +#source_encoding = 'utf-8-sig' + +# The master toctree document. +master_doc = 'index' + +# General information about the project. +project = u'module HYDRO' +copyright = u'2015-2016, EDF' + +# The version info for the project you're documenting, acts as replacement for +# |version| and |release|, also used in various other places throughout the +# built documents. +# +# The short X.Y version. +version = 'V7_6' +# The full version, including alpha/beta/rc tags. +release = 'V7_6-2015.12.18' + +# The language for content autogenerated by Sphinx. Refer to documentation +# for a list of supported languages. +language = 'fr' + +# There are two options for replacing |today|: either, you set today to some +# non-false value, then it is used: +#today = '' +# Else, today_fmt is used as the format for a strftime call. +#today_fmt = '%B %d, %Y' + +# List of patterns, relative to source directory, that match files and +# directories to ignore when looking for source files. +exclude_patterns = ['_build'] + +# The reST default role (used for this markup: `text`) to use for all documents. +#default_role = None + +# If true, '()' will be appended to :func: etc. cross-reference text. +#add_function_parentheses = True + +# If true, the current module name will be prepended to all description +# unit titles (such as .. function::). +#add_module_names = True + +# If true, sectionauthor and moduleauthor directives will be shown in the +# output. They are ignored by default. +#show_authors = False + +# The name of the Pygments (syntax highlighting) style to use. +pygments_style = 'sphinx' + +# A list of ignored prefixes for module index sorting. +#modindex_common_prefix = [] + + +# -- Options for HTML output --------------------------------------------------- + +# The theme to use for HTML and HTML Help pages. See the documentation for +# a list of builtin themes. +html_theme = 'default' + +# Theme options are theme-specific and customize the look and feel of a theme +# further. For a list of options available for each theme, see the +# documentation. +#html_theme_options = {} + +# Add any paths that contain custom themes here, relative to this directory. +#html_theme_path = [] + +# The name for this set of Sphinx documents. If None, it defaults to +# " v documentation". +html_title = project + +# A shorter title for the navigation bar. Default is the same as html_title. +#html_short_title = None + +# The name of an image file (relative to this directory) to place at the top +# of the sidebar. +#html_logo = None + +# The name of an image file (within the static path) to use as favicon of the +# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 +# pixels large. +#html_favicon = None + +# Add any paths that contain custom static files (such as style sheets) here, +# relative to this directory. They are copied after the builtin static files, +# so a file named "default.css" will overwrite the builtin "default.css". +html_static_path = ['../_static'] + +# If not '', a 'Last updated on:' timestamp is inserted at every page bottom, +# using the given strftime format. +#html_last_updated_fmt = '%b %d, %Y' + +# If true, SmartyPants will be used to convert quotes and dashes to +# typographically correct entities. +html_use_smartypants = True + +# Custom sidebar templates, maps document names to template names. +#html_sidebars = {} + +# Additional templates that should be rendered to pages, maps page names to +# template names. +#html_additional_pages = {} + +# If false, no module index is generated. +#html_domain_indices = True + +# If false, no index is generated. +html_use_index = False + +# If true, the index is split into individual pages for each letter. +#html_split_index = False + +# If true, links to the reST sources are added to the pages. +html_show_sourcelink = False + +# If true, "Created using Sphinx" is shown in the HTML footer. Default is True. +html_show_sphinx = False + +# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True. +#html_show_copyright = True + +# If true, an OpenSearch description file will be output, and all pages will +# contain a tag referring to it. The value of this option must be the +# base URL from which the finished HTML is served. +#html_use_opensearch = '' + +# This is the file name suffix for HTML files (e.g. ".xhtml"). +#html_file_suffix = None + +# Output file base name for HTML help builder. +htmlhelp_basename = 'module_HYDRO_V76' + + +# -- Options for LaTeX output -------------------------------------------------- + +latex_elements = { +# The paper size ('letterpaper' or 'a4paper'). +'papersize': 'a4paper', + +# The font size ('10pt', '11pt' or '12pt'). +#'pointsize': '10pt', + +# Additional stuff for the LaTeX preamble. +#latex_preamble = '', + +# Latex figure (float) alignment +'figure_align': 'htbp', +} + +# Grouping the document tree into LaTeX files. List of tuples +# (source start file, target name, title, author, documentclass [howto/manual]). +latex_documents = [ + ('index', 'moduleHYDRO_V76.tex', project, + u'EDF', 'manual'), +] + +# The name of an image file (relative to this directory) to place at the top of +# the title page. +#latex_logo = "../_static/Icone_Salome.png" + +# For "manual" documents, if this is true, then toplevel headings are parts, +# not chapters. +#latex_use_parts = True + +# If true, show page references after internal links. +#latex_show_pagerefs = False + +# If true, show URL addresses after external links. +#latex_show_urls = False + +# Additional stuff for the LaTeX preamble. +latex_preamble = """\usepackage{pdfpages} +\setcounter{tocdepth}{2}""" + +# Documents to append as an appendix to all manuals. +#latex_appendices = [] + +# If false, no module index is generated. +#latex_domain_indices = True + + diff --git a/doc/salome/tutorial/preliminaires.rst b/doc/salome/tutorial/preliminaires.rst index 4ea39a81..0881481e 100644 --- a/doc/salome/tutorial/preliminaires.rst +++ b/doc/salome/tutorial/preliminaires.rst @@ -156,6 +156,7 @@ données préalables Avec trois points, on peut faire une transformation affine de l'iamge, si celle-ci n'est pas correctement orientée. * Disposer des données de bathy au format ascii. + Pour l’instant ces fichiers doivent porter l’extension .xyz (3 colonnes x,y,z) ou .asc (renvoi aux formats) Import d'images -- 2.39.2