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']
45 # Add any paths that contain templates here, relative to this directory.
46 #templates_path = ['_templates']
48 # The suffix of source filenames.
49 source_suffix = '.rst'
51 # The encoding of source files.
52 #source_encoding = 'utf-8'
54 # The master toctree document.
57 # General information about the project.
58 project = u'HYDRO module'
59 copyright = u'2012-2013, EDF'
61 # The version info for the project you're documenting, acts as replacement for
62 # |version| and |release|, also used in various other places throughout the
65 # The short X.Y version.
66 version = '@SALOMEHYDRO_VERSION@'
67 # The full version, including alpha/beta/rc tags.
68 release = '@SALOMEHYDRO_VERSION@'
70 # The language for content autogenerated by Sphinx. Refer to documentation
71 # for a list of supported languages.
74 # There are two options for replacing |today|: either, you set today to some
75 # non-false value, then it is used:
77 # Else, today_fmt is used as the format for a strftime call.
78 #today_fmt = '%B %d, %Y'
80 # List of documents that shouldn't be included in the build.
83 # List of directories, relative to source directory, that shouldn't be searched
85 exclude_trees = ['_build']
87 # The reST default role (used for this markup: `text`) to use for all documents.
90 # If true, '()' will be appended to :func: etc. cross-reference text.
91 #add_function_parentheses = True
93 # If true, the current module name will be prepended to all description
94 # unit titles (such as .. function::).
95 #add_module_names = True
97 # If true, sectionauthor and moduleauthor directives will be shown in the
98 # output. They are ignored by default.
101 # The name of the Pygments (syntax highlighting) style to use.
102 pygments_style = 'sphinx'
104 # A list of ignored prefixes for module index sorting.
105 #modindex_common_prefix = []
108 # -- Options for HTML output ---------------------------------------------------
110 # The theme to use for HTML and HTML Help pages. Major themes that come with
111 # Sphinx are currently 'default' and 'sphinxdoc'.
112 html_theme = 'default'
114 # Theme options are theme-specific and customize the look and feel of a theme
115 # further. For a list of options available for each theme, see the
117 #html_theme_options = {}
119 # Add any paths that contain custom themes here, relative to this directory.
120 #html_theme_path = []
122 # The name for this set of Sphinx documents. If None, it defaults to
123 # "<project> v<release> documentation".
126 # A shorter title for the navigation bar. Default is the same as html_title.
127 #html_short_title = None
129 # The name of an image file (relative to this directory) to place at the top
133 # The name of an image file (within the static path) to use as favicon of the
134 # docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
138 # Add any paths that contain custom static files (such as style sheets) here,
139 # relative to this directory. They are copied after the builtin static files,
140 # so a file named "default.css" will overwrite the builtin "default.css".
141 html_static_path = ['_static']
143 # If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
144 # using the given strftime format.
145 #html_last_updated_fmt = '%b %d, %Y'
147 # If true, SmartyPants will be used to convert quotes and dashes to
148 # typographically correct entities.
149 #html_use_smartypants = True
151 # Custom sidebar templates, maps document names to template names.
154 # Additional templates that should be rendered to pages, maps page names to
156 #html_additional_pages = {}
158 # If false, no module index is generated.
159 #html_use_modindex = True
161 # If false, no index is generated.
162 #html_use_index = True
164 # If true, the index is split into individual pages for each letter.
165 #html_split_index = False
167 # If true, links to the reST sources are added to the pages.
168 #html_show_sourcelink = True
170 # If true, an OpenSearch description file will be output, and all pages will
171 # contain a <link> tag referring to it. The value of this option must be the
172 # base URL from which the finished HTML is served.
173 #html_use_opensearch = ''
175 # If nonempty, this is the file name suffix for HTML files (e.g. ".xhtml").
176 #html_file_suffix = ''
178 # Output file base name for HTML help builder.
179 #htmlhelp_basename = 'HYDROmoduledoc'
182 # -- Options for LaTeX output --------------------------------------------------
184 # The paper size ('letter' or 'a4').
185 #latex_paper_size = 'letter'
187 # The font size ('10pt', '11pt' or '12pt').
188 #latex_font_size = '10pt'
190 # Grouping the document tree into LaTeX files. List of tuples
191 # (source start file, target name, title, author, documentclass [howto/manual]).
193 # ('index', 'HYDROmodule.tex', u'HYDRO module Documentation',
194 # u'EDF R&D', 'manual'),
197 # The name of an image file (relative to this directory) to place at the top of
201 # For "manual" documents, if this is true, then toplevel headings are parts,
203 #latex_use_parts = False
205 # Additional stuff for the LaTeX preamble.
208 # Documents to append as an appendix to all manuals.
209 #latex_appendices = []
211 # If false, no module index is generated.
212 #latex_use_modindex = True