1 # Shaper python API documentation build configuration file, created by
2 # sphinx-quickstart on Thu Oct 15 11:55:42 2015.
4 # This file is execfile()d with the current directory set to its
7 # Note that not all possible configuration values are present in this
10 # All configuration values have a default; values that are commented out
11 # serve to show the default.
17 # If extensions (or modules to document with autodoc) are in another directory,
18 # add these directories to sys.path here. If the directory is relative to the
19 # documentation root, use os.path.abspath to make it absolute, like shown here.
20 sys.path.insert(0, os.path.abspath('..'))
21 sys.path.insert(0, os.path.abspath('../..'))
22 sys.path.insert(0, os.path.abspath('../../..'))
24 # -- General configuration ------------------------------------------------
26 # If your documentation needs a minimal Sphinx version, state it here.
29 # Add any Sphinx extension module names here, as strings. They can be
30 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
36 'sphinx.ext.coverage',
37 'sphinx.ext.viewcode',
38 'sphinx.ext.napoleon',
39 'sphinx.ext.autosummary',
42 import sphinx_rtd_theme
43 extensions += ['sphinx_rtd_theme']
48 # Add any paths that contain templates here, relative to this directory.
49 templates_path = ['_templates']
51 # The suffix of source filenames.
52 source_suffix = '.rst'
54 # The encoding of source files.
55 #source_encoding = 'utf-8-sig'
57 # The master toctree document.
60 # General information about the project.
61 project = 'Shaper python API'
62 copyright = '2014-2020 CEA/DEN, EDF R&D'
64 # The version info for the project you're documenting, acts as replacement for
65 # |version| and |release|, also used in various other places throughout the
68 # The short X.Y version.
70 # The full version, including alpha/beta/rc tags.
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 patterns, relative to source directory, that match files and
84 # directories to ignore when looking for source files.
87 # The reST default role (used for this markup: `text`) to use for all
91 # If true, '()' will be appended to :func: etc. cross-reference text.
92 #add_function_parentheses = True
94 # If true, the current module name will be prepended to all description
95 # unit titles (such as .. function::).
96 #add_module_names = True
98 # If true, sectionauthor and moduleauthor directives will be shown in the
99 # output. They are ignored by default.
100 #show_authors = False
102 # The name of the Pygments (syntax highlighting) style to use.
103 pygments_style = 'sphinx'
105 # A list of ignored prefixes for module index sorting.
106 #modindex_common_prefix = []
108 # If true, keep warnings as "system message" paragraphs in the built documents.
109 #keep_warnings = False
112 # -- Options for HTML output ----------------------------------------------
114 # The theme to use for HTML and HTML Help pages. See the documentation for
115 # a list of builtin themes.
117 html_theme = 'sphinx_rtd_theme'
119 html_theme = 'default' if sphinx.version_info[:2] < (1,3) else 'classic'
121 # Theme options are theme-specific and customize the look and feel of a theme
122 # further. For a list of options available for each theme, see the
125 themes_options['classic'] = {
126 'body_max_width':'none',
129 html_theme_options = themes_options.get(html_theme, {})
131 # Add any paths that contain custom themes here, relative to this directory.
132 #html_theme_path = []
134 # The name for this set of Sphinx documents. If None, it defaults to
135 # "<project> v<release> documentation".
138 # A shorter title for the navigation bar. Default is the same as html_title.
139 #html_short_title = None
141 # The name of an image file (relative to this directory) to place at the top
145 # The name of an image file (within the static path) to use as favicon of the
146 # docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
150 # Add any paths that contain custom static files (such as style sheets) here,
151 # relative to this directory. They are copied after the builtin static files,
152 # so a file named "default.css" will overwrite the builtin "default.css".
153 html_static_path = ['_static']
155 # Add any extra paths that contain custom files (such as robots.txt or
156 # .htaccess) here, relative to this directory. These files are copied
157 # directly to the root of the documentation.
158 #html_extra_path = []
160 # If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
161 # using the given strftime format.
162 #html_last_updated_fmt = '%b %d, %Y'
164 # If true, SmartyPants will be used to convert quotes and dashes to
165 # typographically correct entities.
166 #html_use_smartypants = True
168 # Custom sidebar templates, maps document names to template names.
171 # Additional templates that should be rendered to pages, maps page names to
173 #html_additional_pages = {}
175 # If false, no module index is generated.
176 #html_domain_indices = True
178 # If false, no index is generated.
179 #html_use_index = True
181 # If true, the index is split into individual pages for each letter.
182 #html_split_index = False
184 # If true, links to the reST sources are added to the pages.
185 #html_show_sourcelink = True
187 # If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
188 #html_show_sphinx = True
190 # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
191 #html_show_copyright = True
193 # If true, an OpenSearch description file will be output, and all pages will
194 # contain a <link> tag referring to it. The value of this option must be the
195 # base URL from which the finished HTML is served.
196 #html_use_opensearch = ''
198 # This is the file name suffix for HTML files (e.g. ".xhtml").
199 #html_file_suffix = None
201 # Output file base name for HTML help builder.
202 htmlhelp_basename = 'ShaperpythonAPIdoc'
205 # -- Options for LaTeX output ---------------------------------------------
208 # The paper size ('letterpaper' or 'a4paper').
209 #'papersize': 'letterpaper',
211 # The font size ('10pt', '11pt' or '12pt').
212 #'pointsize': '10pt',
214 # Additional stuff for the LaTeX preamble.
218 # Grouping the document tree into LaTeX files. List of tuples
219 # (source start file, target name, title,
220 # author, documentclass [howto, manual, or own class]).
222 ('index', 'ShaperpythonAPI.tex', 'Shaper python API Documentation',
223 'Renaud Nédélec', 'manual'),
226 # The name of an image file (relative to this directory) to place at the top of
230 # For "manual" documents, if this is true, then toplevel headings are parts,
232 #latex_use_parts = False
234 # If true, show page references after internal links.
235 #latex_show_pagerefs = False
237 # If true, show URL addresses after external links.
238 #latex_show_urls = False
240 # Documents to append as an appendix to all manuals.
241 #latex_appendices = []
243 # If false, no module index is generated.
244 #latex_domain_indices = True
247 # -- Options for manual page output ---------------------------------------
249 # One entry per manual page. List of tuples
250 # (source start file, name, description, authors, manual section).
252 ('index', 'shaperpythonapi', 'Shaper python API Documentation',
253 ['Renaud Nédélec'], 1)
256 # If true, show URL addresses after external links.
257 #man_show_urls = False
260 # -- Options for Texinfo output -------------------------------------------
262 # Grouping the document tree into Texinfo files. List of tuples
263 # (source start file, target name, title, author,
264 # dir menu entry, description, category)
265 texinfo_documents = [
266 ('index', 'ShaperpythonAPI', 'Shaper python API Documentation',
267 'Renaud Nédélec', 'ShaperpythonAPI', 'One line description of project.',
271 # Documents to append as an appendix to all manuals.
272 #texinfo_appendices = []
274 # If false, no module index is generated.
275 #texinfo_domain_indices = True
277 # How to display URL addresses: 'footnote', 'no', or 'inline'.
278 #texinfo_show_urls = 'footnote'
280 # If true, do not generate a @detailmenu in the "Top" node's menu.
281 #texinfo_no_detailmenu = False
283 autodoc_member_order = 'bysource'