]> SALOME platform Git repositories - modules/hydro.git/commitdiff
Salome HOME
introduction tutoriel en Sphinx
authorPaul RASCLE <paul.rascle@edf.fr>
Tue, 3 Nov 2015 17:47:12 +0000 (18:47 +0100)
committerPaul RASCLE <paul.rascle@edf.fr>
Tue, 3 Nov 2015 17:47:12 +0000 (18:47 +0100)
doc/salome/CMakeLists.txt
doc/salome/gui/HYDRO/mainpage.h
doc/salome/tutorial/CMakeLists.txt [new file with mode: 0644]
doc/salome/tutorial/_static/HYDRO.png [new file with mode: 0644]
doc/salome/tutorial/conf.py.in [new file with mode: 0644]
doc/salome/tutorial/index.rst [new file with mode: 0644]

index 9a0a069ed2ad676335121ae21cb6bb6fe2c693ac..35f9e3387f7b5e7db92f200793730c75b716b5ad 100644 (file)
@@ -22,3 +22,4 @@
 
 ADD_SUBDIRECTORY(gui)
 ADD_SUBDIRECTORY(examples)
+ADD_SUBDIRECTORY(tutorial)
index f57f067382aade068d9ed6213ec9d3a1bbdf3206..f990d0efbcf1aa2319f0b3740c973dbea67fa4f9 100644 (file)
@@ -7,6 +7,8 @@
 /**
   @mainpage
 
+  <A HREF="../HYDRO_tutorial/index.html">A Tutorial on SALOME HYDRO </A>
+
   The HYDRO GUI project has been developed for a hydrodynamic laboratory in the EDF R&D company
   in the domain of the landscape modelling (construction of channels, dams, changing the course of the rivers etc).
   It represents a pre-processor for the geometry modelling of the natural and artificial objects on the landscape.
diff --git a/doc/salome/tutorial/CMakeLists.txt b/doc/salome/tutorial/CMakeLists.txt
new file mode 100644 (file)
index 0000000..f0b3de9
--- /dev/null
@@ -0,0 +1,46 @@
+#  Copyright (C) 2012-2013 EDF
+#
+#  This file is part of SALOME HYDRO module.
+#
+#  SALOME HYDRO module is free software: you can redistribute it and/or modify
+#  it under the terms of the GNU General Public License as published by
+#  the Free Software Foundation, either version 3 of the License, or
+#  (at your option) any later version.
+#
+#  SALOME HYDRO module 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 General Public License for more details.
+#
+#  You should have received a copy of the GNU General Public License
+#  along with SALOME HYDRO module.  If not, see <http://www.gnu.org/licenses/>.
+
+SET(RSTFILES
+  index.rst
+)
+
+SET(SPHINXOPTS )
+SET(SOURCEDIR ${CMAKE_CURRENT_SOURCE_DIR})
+SET(PAPEROPT_a4 -D latex_paper_size=a4)
+SET(ALLSPHINXOPTS -d doctrees ${PAPEROPT_a4} ${SPHINXOPTS} ${SOURCEDIR})
+
+# install user's documentation
+
+SALOME_CONFIGURE_FILE(conf.py.in conf.py)
+
+SET(HTML_ROOT_FILE html/index.html)
+
+ADD_CUSTOM_COMMAND(OUTPUT ${HTML_ROOT_FILE} 
+  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}
+)
+
+ADD_CUSTOM_TARGET(BUILD_HTML ALL DEPENDS ${HTML_ROOT_FILE})
+
+INSTALL(DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}/html/ 
+  DESTINATION ${SALOME_INSTALL_DOC}/gui/HYDRO_tutorial
+  PATTERN ".buildinfo" EXCLUDE
+)
diff --git a/doc/salome/tutorial/_static/HYDRO.png b/doc/salome/tutorial/_static/HYDRO.png
new file mode 100644 (file)
index 0000000..4b1a756
Binary files /dev/null and b/doc/salome/tutorial/_static/HYDRO.png differ
diff --git a/doc/salome/tutorial/conf.py.in b/doc/salome/tutorial/conf.py.in
new file mode 100644 (file)
index 0000000..b43e1a5
--- /dev/null
@@ -0,0 +1,212 @@
+# -*- coding: utf-8 -*-
+#
+#  Copyright (C) 2012-2013 EDF
+#
+#  This file is part of SALOME HYDRO module.
+#
+#  SALOME HYDRO module is free software: you can redistribute it and/or modify
+#  it under the terms of the GNU General Public License as published by
+#  the Free Software Foundation, either version 3 of the License, or
+#  (at your option) any later version.
+#
+#  SALOME HYDRO module 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 General Public License for more details.
+#
+#  You should have received a copy of the GNU General Public License
+#  along with SALOME HYDRO module.  If not, see <http://www.gnu.org/licenses/>.
+
+
+# HYDRO module documentation build configuration file, created by
+# sphinx-quickstart.
+#
+# 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.append(os.path.abspath('.'))
+
+# -- General configuration -----------------------------------------------------
+
+# 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']
+
+# 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'
+
+# The master toctree document.
+master_doc = 'index'
+
+# General information about the project.
+project = u'HYDRO module'
+copyright = u'2012-2013, 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@'
+# The full version, including alpha/beta/rc tags.
+release = '@SALOMEHYDRO_VERSION@'
+
+# The language for content autogenerated by Sphinx. Refer to documentation
+# for a list of supported languages.
+#language = None
+
+# 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 documents that shouldn't be included in the build.
+#unused_docs = []
+
+# List of directories, relative to source directory, that shouldn't be searched
+# for source files.
+exclude_trees = ['_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.  Major themes that come with
+# Sphinx are currently 'default' and 'sphinxdoc'.
+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
+# "<project> v<release> documentation".
+#html_title = None
+
+# 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_use_modindex = True
+
+# If false, no index is generated.
+#html_use_index = True
+
+# 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 = True
+
+# If true, an OpenSearch description file will be output, and all pages will
+# contain a <link> tag referring to it.  The value of this option must be the
+# base URL from which the finished HTML is served.
+#html_use_opensearch = ''
+
+# If nonempty, this is the file name suffix for HTML files (e.g. ".xhtml").
+#html_file_suffix = ''
+
+# Output file base name for HTML help builder.
+#htmlhelp_basename = 'HYDROmoduledoc'
+
+
+# -- Options for LaTeX output --------------------------------------------------
+
+# The paper size ('letter' or 'a4').
+#latex_paper_size = 'letter'
+
+# The font size ('10pt', '11pt' or '12pt').
+#latex_font_size = '10pt'
+
+# 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'),
+#]
+
+# The name of an image file (relative to this directory) to place at the top of
+# the title page.
+#latex_logo = None
+
+# For "manual" documents, if this is true, then toplevel headings are parts,
+# not chapters.
+#latex_use_parts = False
+
+# Additional stuff for the LaTeX preamble.
+#latex_preamble = ''
+
+# Documents to append as an appendix to all manuals.
+#latex_appendices = []
+
+# If false, no module index is generated.
+#latex_use_modindex = True
diff --git a/doc/salome/tutorial/index.rst b/doc/salome/tutorial/index.rst
new file mode 100644 (file)
index 0000000..c1604a0
--- /dev/null
@@ -0,0 +1,38 @@
+..
+   Copyright (C) 2012-2013 EDF
+
+   This file is part of SALOME HYDRO module.
+
+   SALOME HYDRO module is free software: you can redistribute it and/or modify
+   it under the terms of the GNU General Public License as published by
+   the Free Software Foundation, either version 3 of the License, or
+   (at your option) any later version.
+
+   SALOME HYDRO module 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 General Public License for more details.
+
+   You should have received a copy of the GNU General Public License
+   along with SALOME HYDRO module.  If not, see <http://www.gnu.org/licenses/>.
+
+
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+Hydro module documentation
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+
+.. |Hydro_module_button| image:: /_static/HYDRO.png
+   :align: middle
+   :width: 16pt
+   :height: 16pt
+
+This documentation covers the usage of Hydro module in Salome. This module
+aims at providing services for the usage of Telemac and Mascaret codes. To
+activate this module, click on the |Hydro_module_button| button in the
+toolbar or select "Hydro" item in the "SALOME" menu. The first part of
+this guide addresses simple use cases (how to run the codes from Salome-Hydro
+platform) while the second part presents more advanced topics (code coupling).
+
+.. toctree::
+   :maxdepth: 2
+