#
# Author: Jean-Philippe Argaud, jean-philippe.argaud@edf.fr, EDF R&D
-#
-# ADAO documentation build configuration file, created by
-# sphinx-quickstart on Wed Jun 16 15:48:00 2010.
-#
-# 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, sphinx
+import sphinx_rtd_theme
-# 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('.'))
try:
sys.path.append(os.path.abspath("../../bin"))
import module_version
except:
pass
-# -- General configuration -----------------------------------------------------
+# -- Project information -----------------------------------------------------
+
+project = u'%s'%module_version.name
+author = u'Jean-Philippe ARGAUD'
+copyright = u'2008-%s, EDF R&D, %s'%(module_version.year,author)
+version = '%s'%module_version.version
+release = '%s'%module_version.version
+doctitle = u"%s documentation"%module_version.name
+docfull = u"Aiding for Data Assimilation and Optimization"
+
+# -- 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.
from distutils.version import LooseVersion #, StrictVersion
if LooseVersion(sphinx.__version__) < LooseVersion("1.4.0"):
- extensions = ["sphinx.ext.pngmath"]
+ extensions = [
+ 'sphinx.ext.pngmath',
+ 'sphinx_rtd_theme',
+ ]
else:
- extensions = ["sphinx.ext.imgmath"]
+ extensions = [
+ 'sphinx.ext.imgmath',
+ 'sphinx_rtd_theme',
+ ]
#
-
-# 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'%s'%module_version.name
-copyright = u'2008-%s, EDF R&D, Jean-Philippe ARGAUD'%module_version.year
-
-# 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 = '7\_main'
-version = '%s'%module_version.version
-# The full version, including alpha/beta/rc tags.
-# release = '7\_main'
-release = '%s'%module_version.version
-
-# The language for content autogenerated by Sphinx. Refer to documentation
-# for a list of supported languages.
-language = 'en'
-
-# 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 = ['snippets',]
-
-# 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 = "Documentation %s %s"%(module_version.name,module_version.version)
-
-# 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".
+source_suffix = '.rst'
+source_encoding = 'utf-8'
+master_doc = 'index'
+language = 'en'
+exclude_patterns = ['snippets', 'scripts', 'resources', '_build', 'Thumbs.db', '.DS_Store', 'Grenier']
+pygments_style = None
+templates_path = ['_templates']
+exclude_trees = ['snippets',]
+
+# -- Options for HTML output -------------------------------------------------
+
+html_theme = "sphinx_rtd_theme"
+# html_theme = 'default'
+# html_theme = 'alabaster'
+html_title = doctitle
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 = False
-# 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.
+# -- Options for HTMLHelp output ---------------------------------------------
htmlhelp_basename = 'ADAOdoc'
+# -- Options for LaTeX output ------------------------------------------------
-# -- Options for LaTeX output --------------------------------------------------
-
-# The paper size ('letter' or 'a4').
-latex_elements = {'papersize':'letterpaper'}
-
-# 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_elements = {
+ 'papersize': 'letterpaper',
+ 'pointsize': '10pt',
+ 'figure_align': 'htbp',
+}
latex_documents = [
- ('index', 'ADAO.tex', u'ADAO documentation',
- u'Jean-Philippe ARGAUD', 'manual'),
+ ('index', 'ADAO.tex', doctitle,
+ author, '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 = ''
+# -- Options for manual page output ------------------------------------------
-# Documents to append as an appendix to all manuals.
-#latex_appendices = []
-
-# If false, no module index is generated.
-#latex_use_modindex = True
-
-# -- Options for Epub output ---------------------------------------------------
-
-# Bibliographic Dublin Core info.
-epub_title = project
-epub_author = u'Jean-Philippe ARGAUD'
-epub_publisher = u'Jean-Philippe ARGAUD'
-epub_copyright = copyright
-
-# The language of the text. It defaults to the language option
-# or en if the language is not set.
-#epub_language = ''
-
-# The scheme of the identifier. Typical schemes are ISBN or URL.
-#epub_scheme = ''
-
-# The unique identifier of the text. This can be a ISBN number
-# or the project homepage.
-#epub_identifier = ''
-
-# A unique identification for the text.
-#epub_uid = ''
-
-# HTML files that should be inserted before the pages created by sphinx.
-# The format is a list of tuples containing the path and title.
-#epub_pre_files = []
-
-# HTML files shat should be inserted after the pages created by sphinx.
-# The format is a list of tuples containing the path and title.
-#epub_post_files = []
-
-# A list of files that should not be packed into the epub file.
-#epub_exclude_files = []
+man_pages = [
+ (master_doc, 'adao', doctitle,
+ [author], 1)
+]
-# The depth of the table of contents in toc.ncx.
-#epub_tocdepth = 3
+# -- Options for Texinfo output ----------------------------------------------
+texinfo_documents = [
+ (master_doc, 'ADAO', doctitle,
+ author, 'ADAO', docfull,
+ 'Miscellaneous'),
+]
+# -- Options for Epub output -------------------------------------------------
-# Allow duplicate toc entries.
-#epub_tocdup = True
+epub_title = doctitle
+epub_author = author
+epub_publisher = author
+epub_copyright = copyright
+epub_exclude_files = ['search.html']
# -- Options for PDF output --------------------------------------------------
-# Grouping the document tree into PDF files. List of tuples
-# (source start file, target name, title, author, options).
-#
-# If there is more than one author, separate them with \\.
-# For example: r'Guido van Rossum\\Fred L. Drake, Jr., editor'
-#
-# The options element is a dictionary that lets you override
-# this config per-document.
-# For example,
-# ('index', u'MyProject', u'My Project', u'Author Name',
-# dict(pdf_compressed = True))
-# would mean that specific document would be compressed
-# regardless of the global pdf_compressed setting.
+
pdf_documents = [
- ('contents', u'ADAO', u'ADAO', u'Jean-Philippe ARGAUD', dict(pdf_compressed = True)),
+ ('contents', u'ADAO', u'ADAO', author, dict(pdf_compressed = True)),
]
-# A comma-separated list of custom stylesheets. Example:
pdf_stylesheets = ['sphinx','kerning','a4']
-# Create a compressed PDF
-# Use True/False or 1/0
-# Example: compressed=True
-#pdf_compressed = False
pdf_compressed = True
-# A colon-separated list of folders to search for fonts. Example:
-# pdf_font_path = ['/usr/share/fonts', '/usr/share/texmf-dist/fonts/']
-# Language to be used for hyphenation support
-#pdf_language = "en_US"
-# Mode for literal blocks wider than the frame. Can be
-# overflow, shrink or truncate
-#pdf_fit_mode = "shrink"
-# Section level that forces a break page.
-# For example: 1 means top-level sections start in a new page
-# 0 means disabled
-#pdf_break_level = 0
-# When a section starts in a new page, force it to be 'even', 'odd',
-# or just use 'any'
-#pdf_breakside = 'any'
-# Insert footnotes where they are defined instead of
-# at the end.
-#pdf_inline_footnotes = True
-# verbosity level. 0 1 or 2
-#pdf_verbosity = 0
-# If false, no index is generated.
-#pdf_use_index = True
-# If false, no modindex is generated.
-#pdf_use_modindex = True
-# If false, no coverpage is generated.
-#pdf_use_coverpage = True
-# Name of the cover page template to use
-#pdf_cover_template = 'sphinxcover.tmpl'
-# Documents to append as an appendix to all manuals.
-#pdf_appendices = []
-# Enable experimental feature to split table cells. Use it
-# if you get "DelayedTable too big" errors
-#pdf_splittables = False
-# Set the default DPI for images
-#pdf_default_dpi = 72
-# Enable rst2pdf extension modules (default is empty list)
-# you need vectorpdf for better sphinx's graphviz support
-#pdf_extensions = ['vectorpdf']
-# Page template name for "regular" pages
-#pdf_page_template = 'cutePage'
+pdf_inline_footnotes = True
+
+# -- Extension configuration -------------------------------------------------
the document. And, to comply with the module requirements, be sure to read the
part :ref:`section_license`.
-**Table of contents**
-
.. toctree::
+ :caption: Table of contents
+ :name: mastertoc
:maxdepth: 2
+ :numbered: 2
intro
theory
* :ref:`genindex`
* :ref:`search`
-
-.. * :ref:`section_glossary`
================================================================================
The aim of the ADAO module is **to help using data assimilation or optimization
-methodology in conjunction with other modules or simulation codes in Python
-[Python]_ or SALOME context [Salome]_**. The ADAO module provides a simple
+methodology in conjunction with other modules or simulation codes in Python**
+[Python]_ **or SALOME context** [Salome]_. The ADAO module provides a simple
interface to some standard algorithms of data assimilation or optimization, as
well as test or verification ones. It allows integration of their use in a
Python or SALOME study. Calculation or simulation user modules have to provide
#
# Author: Jean-Philippe Argaud, jean-philippe.argaud@edf.fr, EDF R&D
-#
-# ADAO documentation build configuration file, created by
-# sphinx-quickstart on Wed Jun 16 15:48:00 2010.
-#
-# 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, sphinx
+import sphinx_rtd_theme
-# 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('.'))
try:
sys.path.append(os.path.abspath("../../bin"))
import module_version
except:
pass
-# -- General configuration -----------------------------------------------------
+# -- Project information -----------------------------------------------------
+
+project = u'%s'%module_version.name
+author = u'Jean-Philippe ARGAUD'
+copyright = u'2008-%s, EDF R&D, %s'%(module_version.year,author)
+version = '%s'%module_version.version
+release = '%s'%module_version.version
+doctitle = u"Documentation %s"%module_version.name
+docfull = u"Assimilation de Données et Aide à l'Optimisation"
+
+# -- 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.
from distutils.version import LooseVersion #, StrictVersion
if LooseVersion(sphinx.__version__) < LooseVersion("1.4.0"):
- extensions = ["sphinx.ext.pngmath"]
+ extensions = [
+ 'sphinx.ext.pngmath',
+ 'sphinx_rtd_theme',
+ ]
else:
- extensions = ["sphinx.ext.imgmath"]
+ extensions = [
+ 'sphinx.ext.imgmath',
+ 'sphinx_rtd_theme',
+ ]
#
-
-# 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'%s'%module_version.name
-copyright = u'2008-%s, EDF R&D, Jean-Philippe ARGAUD'%module_version.year
-
-# 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 = '7\_main'
-version = '%s'%module_version.version
-# The full version, including alpha/beta/rc tags.
-# release = '7\_main'
-release = '%s'%module_version.version
-
-# 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 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 = ['snippets',]
-
-# 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 = "Documentation %s %s"%(module_version.name,module_version.version)
-
-# 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".
+source_suffix = '.rst'
+source_encoding = 'utf-8'
+master_doc = 'index'
+language = 'fr'
+exclude_patterns = ['snippets', 'scripts', 'resources', '_build', 'Thumbs.db', '.DS_Store', 'Grenier']
+pygments_style = None
+templates_path = ['_templates']
+exclude_trees = ['snippets',]
+
+# -- Options for HTML output -------------------------------------------------
+
+html_theme = "sphinx_rtd_theme"
+# html_theme = 'default'
+# html_theme = 'alabaster'
+html_title = doctitle
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 = False
-# 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.
+# -- Options for HTMLHelp output ---------------------------------------------
htmlhelp_basename = 'ADAOdoc'
+# -- Options for LaTeX output ------------------------------------------------
-# -- Options for LaTeX output --------------------------------------------------
-
-# The paper size ('letter' or 'a4').
-latex_elements = {'papersize':'a4paper'}
-
-# 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_elements = {
+ 'papersize': 'a4paper',
+ 'pointsize': '10pt',
+ 'figure_align': 'htbp',
+}
latex_documents = [
- ('index', 'ADAO.tex', u'Documentation ADAO',
- u'Jean-Philippe ARGAUD', 'manual'),
+ ('index', 'ADAO.tex', doctitle,
+ author, '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 = ''
+# -- Options for manual page output ------------------------------------------
-# Documents to append as an appendix to all manuals.
-#latex_appendices = []
-
-# If false, no module index is generated.
-#latex_use_modindex = True
-
-# -- Options for Epub output ---------------------------------------------------
-
-# Bibliographic Dublin Core info.
-epub_title = project
-epub_author = u'Jean-Philippe ARGAUD'
-epub_publisher = u'Jean-Philippe ARGAUD'
-epub_copyright = copyright
-
-# The language of the text. It defaults to the language option
-# or en if the language is not set.
-#epub_language = ''
-
-# The scheme of the identifier. Typical schemes are ISBN or URL.
-#epub_scheme = ''
-
-# The unique identifier of the text. This can be a ISBN number
-# or the project homepage.
-#epub_identifier = ''
-
-# A unique identification for the text.
-#epub_uid = ''
-
-# HTML files that should be inserted before the pages created by sphinx.
-# The format is a list of tuples containing the path and title.
-#epub_pre_files = []
-
-# HTML files shat should be inserted after the pages created by sphinx.
-# The format is a list of tuples containing the path and title.
-#epub_post_files = []
-
-# A list of files that should not be packed into the epub file.
-#epub_exclude_files = []
+man_pages = [
+ (master_doc, 'adao', doctitle,
+ [author], 1)
+]
-# The depth of the table of contents in toc.ncx.
-#epub_tocdepth = 3
+# -- Options for Texinfo output ----------------------------------------------
+texinfo_documents = [
+ (master_doc, 'ADAO', doctitle,
+ author, 'ADAO', docfull,
+ 'Miscellaneous'),
+]
+# -- Options for Epub output -------------------------------------------------
-# Allow duplicate toc entries.
-#epub_tocdup = True
+epub_title = doctitle
+epub_author = author
+epub_publisher = author
+epub_copyright = copyright
+epub_exclude_files = ['search.html']
# -- Options for PDF output --------------------------------------------------
-# Grouping the document tree into PDF files. List of tuples
-# (source start file, target name, title, author, options).
-#
-# If there is more than one author, separate them with \\.
-# For example: r'Guido van Rossum\\Fred L. Drake, Jr., editor'
-#
-# The options element is a dictionary that lets you override
-# this config per-document.
-# For example,
-# ('index', u'MyProject', u'My Project', u'Author Name',
-# dict(pdf_compressed = True))
-# would mean that specific document would be compressed
-# regardless of the global pdf_compressed setting.
+
pdf_documents = [
- ('contents', u'ADAO', u'ADAO', u'Jean-Philippe ARGAUD', dict(pdf_compressed = True)),
+ ('contents', u'ADAO', u'ADAO', author, dict(pdf_compressed = True)),
]
-# A comma-separated list of custom stylesheets. Example:
pdf_stylesheets = ['sphinx','kerning','a4']
-# Create a compressed PDF
-# Use True/False or 1/0
-# Example: compressed=True
-#pdf_compressed = False
pdf_compressed = True
-# A colon-separated list of folders to search for fonts. Example:
-# pdf_font_path = ['/usr/share/fonts', '/usr/share/texmf-dist/fonts/']
-# Language to be used for hyphenation support
-#pdf_language = "en_US"
-# Mode for literal blocks wider than the frame. Can be
-# overflow, shrink or truncate
-#pdf_fit_mode = "shrink"
-# Section level that forces a break page.
-# For example: 1 means top-level sections start in a new page
-# 0 means disabled
-#pdf_break_level = 0
-# When a section starts in a new page, force it to be 'even', 'odd',
-# or just use 'any'
-#pdf_breakside = 'any'
-# Insert footnotes where they are defined instead of
-# at the end.
-#pdf_inline_footnotes = True
-# verbosity level. 0 1 or 2
-#pdf_verbosity = 0
-# If false, no index is generated.
-#pdf_use_index = True
-# If false, no modindex is generated.
-#pdf_use_modindex = True
-# If false, no coverpage is generated.
-#pdf_use_coverpage = True
-# Name of the cover page template to use
-#pdf_cover_template = 'sphinxcover.tmpl'
-# Documents to append as an appendix to all manuals.
-#pdf_appendices = []
-# Enable experimental feature to split table cells. Use it
-# if you get "DelayedTable too big" errors
-#pdf_splittables = False
-# Set the default DPI for images
-#pdf_default_dpi = 72
-# Enable rst2pdf extension modules (default is empty list)
-# you need vectorpdf for better sphinx's graphviz support
-#pdf_extensions = ['vectorpdf']
-# Page template name for "regular" pages
-#pdf_page_template = 'cutePage'
+pdf_inline_footnotes = True
+
+# -- Extension configuration -------------------------------------------------
document. Enfin, pour respecter les exigences de licence du module, n'oubliez
pas de lire la partie :ref:`section_license`.
-**Table des matières**
-
.. toctree::
+ :caption: Table des matières
+ :name: mastertoc
:maxdepth: 2
+ :numbered: 2
intro
theory
* :ref:`genindex`
* :ref:`search`
-
-.. * :ref:`section_glossary`
Le but du module ADAO est **d'aider à l'usage de l'assimilation de données ou
de l'optimisation en lien avec d'autres modules ou codes de simulation dans un
-contexte Python [Python]_ ou SALOME [Salome]_**. Le module ADAO fournit une
+contexte Python** [Python]_ **ou SALOME** [Salome]_. Le module ADAO fournit une
interface simple à des algorithmes classiques d'assimilation de données ou
d'optimisation, ainsi que de tests ou vérifications. Il permet d'intégrer leur
usage dans une étude Python ou SALOME. Les modules utilisateurs de calcul ou de
