1 # -*- coding: utf-8 -*-
3 # Copyright (C) 2012-2013 EDF
5 # This file is part of SALOME HYDRO module.
7 # SALOME HYDRO module is free software: you can redistribute it and/or modify
8 # it under the terms of the GNU General Public License as published by
9 # the Free Software Foundation, either version 3 of the License, or
10 # (at your option) any later version.
12 # SALOME HYDRO module is distributed in the hope that it will be useful,
13 # but WITHOUT ANY WARRANTY; without even the implied warranty of
14 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 # GNU General Public License for more details.
17 # You should have received a copy of the GNU General Public License
18 # along with SALOME HYDRO module. If not, see <http://www.gnu.org/licenses/>.
21 # HYDRO module documentation build configuration file, created by
24 # This file is execfile()d with the current directory set to its containing dir.
26 # Note that not all possible configuration values are present in this
29 # All configuration values have a default; values that are commented out
30 # serve to show the default.
34 # If extensions (or modules to document with autodoc) are in another directory,
35 # add these directories to sys.path here. If the directory is relative to the
36 # documentation root, use os.path.abspath to make it absolute, like shown here.
37 #sys.path.append(os.path.abspath('.'))
39 # -- General configuration -----------------------------------------------------
41 # Add any Sphinx extension module names here, as strings. They can be extensions
42 # coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
43 #extensions = ['sphinx.ext.extlinks']
44 extensions = ['sphinx.ext.viewcode','sphinx.ext.pngmath']
46 # Add any paths that contain templates here, relative to this directory.
47 #templates_path = ['_templates']
49 # The suffix of source filenames.
50 source_suffix = '.rst'
52 # The encoding of source files.
53 #source_encoding = 'utf-8'
55 # The master toctree document.
58 # General information about the project.
59 project = u'SALOME HYDRO'
60 copyright = u'2015-2017, EDF'
62 # The version info for the project you're documenting, acts as replacement for
63 # |version| and |release|, also used in various other places throughout the
66 # The short X.Y version.
67 #version = '@SALOMEHYDRO_VERSION@'
69 # The full version, including alpha/beta/rc tags.
70 #release = '@SALOMEHYDRO_VERSION@'
71 release = '8.3.0- module HYDRO -@SALOMEHYDRO_VERSION@-2017.07.10'
73 # The language for content autogenerated by Sphinx. Refer to documentation
74 # for a list of supported languages.
77 # There are two options for replacing |today|: either, you set today to some
78 # non-false value, then it is used:
80 # Else, today_fmt is used as the format for a strftime call.
81 #today_fmt = '%B %d, %Y'
83 # List of documents that shouldn't be included in the build.
86 # List of directories, relative to source directory, that shouldn't be searched
88 exclude_trees = ['_build']
90 # The reST default role (used for this markup: `text`) to use for all documents.
93 # If true, '()' will be appended to :func: etc. cross-reference text.
94 #add_function_parentheses = True
96 # If true, the current module name will be prepended to all description
97 # unit titles (such as .. function::).
98 #add_module_names = True
100 # If true, sectionauthor and moduleauthor directives will be shown in the
101 # output. They are ignored by default.
102 #show_authors = False
104 # The name of the Pygments (syntax highlighting) style to use.
105 pygments_style = 'sphinx'
107 # A list of ignored prefixes for module index sorting.
108 #modindex_common_prefix = []
111 # -- Options for HTML output ---------------------------------------------------
113 # The theme to use for HTML and HTML Help pages. Major themes that come with
114 # Sphinx are currently 'default' and 'sphinxdoc'.
115 html_theme = 'default'
117 # Theme options are theme-specific and customize the look and feel of a theme
118 # further. For a list of options available for each theme, see the
120 #html_theme_options = {}
122 # Add any paths that contain custom themes here, relative to this directory.
123 #html_theme_path = []
125 # The name for this set of Sphinx documents. If None, it defaults to
126 # "<project> v<release> documentation".
129 # A shorter title for the navigation bar. Default is the same as html_title.
130 #html_short_title = None
132 # The name of an image file (relative to this directory) to place at the top
136 # The name of an image file (within the static path) to use as favicon of the
137 # docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
141 # Add any paths that contain custom static files (such as style sheets) here,
142 # relative to this directory. They are copied after the builtin static files,
143 # so a file named "default.css" will overwrite the builtin "default.css".
144 html_static_path = ['../_static']
146 # If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
147 # using the given strftime format.
148 #html_last_updated_fmt = '%b %d, %Y'
150 # If true, SmartyPants will be used to convert quotes and dashes to
151 # typographically correct entities.
152 #html_use_smartypants = True
154 # Custom sidebar templates, maps document names to template names.
157 # Additional templates that should be rendered to pages, maps page names to
159 #html_additional_pages = {}
161 # If false, no module index is generated.
162 #html_use_modindex = True
164 # If false, no index is generated.
165 #html_use_index = True
167 # If true, the index is split into individual pages for each letter.
168 #html_split_index = False
170 # If true, links to the reST sources are added to the pages.
171 #html_show_sourcelink = True
173 # If true, an OpenSearch description file will be output, and all pages will
174 # contain a <link> tag referring to it. The value of this option must be the
175 # base URL from which the finished HTML is served.
176 #html_use_opensearch = ''
178 # If nonempty, this is the file name suffix for HTML files (e.g. ".xhtml").
179 #html_file_suffix = ''
181 # Output file base name for HTML help builder.
182 htmlhelp_basename = 'module_HYDRO_tutorial'
185 # -- Options for LaTeX output --------------------------------------------------
188 # The paper size ('letter' or 'a4').
189 #latex_paper_size = 'a4'
190 'papersize': 'a4paper',
192 # The font size ('10pt', '11pt' or '12pt').
193 #latex_font_size = '10pt'
195 # Latex figure (float) alignment
196 'figure_align': 'htbp',
199 # Grouping the document tree into LaTeX files. List of tuples
200 # (source start file, target name, title, author, documentclass [howto/manual]).
202 ('index', 'moduleHYDRO_tutorial.tex', u'module HYDRO Documentation',
206 # The name of an image file (relative to this directory) to place at the top of
210 # For "manual" documents, if this is true, then toplevel headings are parts,
212 #latex_use_parts = False
214 # Additional stuff for the LaTeX preamble.
216 latex_preamble = """\usepackage{pdfpages}
217 \setcounter{tocdepth}{2}"""
219 # Documents to append as an appendix to all manuals.
220 #latex_appendices = []
222 # If false, no module index is generated.
223 #latex_use_modindex = True