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.
16 # If extensions (or modules to document with autodoc) are in another directory,
17 # add these directories to sys.path here. If the directory is relative to the
18 # documentation root, use os.path.abspath to make it absolute, like shown here.
19 sys.path.insert(0, os.path.abspath('..'))
20 sys.path.insert(0, os.path.abspath('../..'))
21 sys.path.insert(0, os.path.abspath('../../..'))
23 # -- General configuration ------------------------------------------------
25 # If your documentation needs a minimal Sphinx version, state it here.
28 # Add any Sphinx extension module names here, as strings. They can be
29 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
35 'sphinx.ext.coverage',
36 'sphinx.ext.viewcode',
37 'sphinx.ext.napoleon',
38 'sphinx.ext.autosummary',
41 # Add any paths that contain templates here, relative to this directory.
42 templates_path = ['_templates']
44 # The suffix of source filenames.
45 source_suffix = '.rst'
47 # The encoding of source files.
48 #source_encoding = 'utf-8-sig'
50 # The master toctree document.
53 # General information about the project.
54 project = 'Shaper python API'
55 copyright = '2014-2019 CEA/DEN, EDF R&D'
57 # The version info for the project you're documenting, acts as replacement for
58 # |version| and |release|, also used in various other places throughout the
61 # The short X.Y version.
63 # The full version, including alpha/beta/rc tags.
66 # The language for content autogenerated by Sphinx. Refer to documentation
67 # for a list of supported languages.
70 # There are two options for replacing |today|: either, you set today to some
71 # non-false value, then it is used:
73 # Else, today_fmt is used as the format for a strftime call.
74 #today_fmt = '%B %d, %Y'
76 # List of patterns, relative to source directory, that match files and
77 # directories to ignore when looking for source files.
80 # The reST default role (used for this markup: `text`) to use for all
84 # If true, '()' will be appended to :func: etc. cross-reference text.
85 #add_function_parentheses = True
87 # If true, the current module name will be prepended to all description
88 # unit titles (such as .. function::).
89 #add_module_names = True
91 # If true, sectionauthor and moduleauthor directives will be shown in the
92 # output. They are ignored by default.
95 # The name of the Pygments (syntax highlighting) style to use.
96 pygments_style = 'sphinx'
98 # A list of ignored prefixes for module index sorting.
99 #modindex_common_prefix = []
101 # If true, keep warnings as "system message" paragraphs in the built documents.
102 #keep_warnings = False
105 # -- Options for HTML output ----------------------------------------------
107 # The theme to use for HTML and HTML Help pages. See the documentation for
108 # a list of builtin themes.
109 html_theme = 'default'
111 # Theme options are theme-specific and customize the look and feel of a theme
112 # further. For a list of options available for each theme, see the
114 #html_theme_options = {}
116 # Add any paths that contain custom themes here, relative to this directory.
117 #html_theme_path = []
119 # The name for this set of Sphinx documents. If None, it defaults to
120 # "<project> v<release> documentation".
123 # A shorter title for the navigation bar. Default is the same as html_title.
124 #html_short_title = None
126 # The name of an image file (relative to this directory) to place at the top
130 # The name of an image file (within the static path) to use as favicon of the
131 # docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
135 # Add any paths that contain custom static files (such as style sheets) here,
136 # relative to this directory. They are copied after the builtin static files,
137 # so a file named "default.css" will overwrite the builtin "default.css".
138 html_static_path = ['_static']
140 # Add any extra paths that contain custom files (such as robots.txt or
141 # .htaccess) here, relative to this directory. These files are copied
142 # directly to the root of the documentation.
143 #html_extra_path = []
145 # If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
146 # using the given strftime format.
147 #html_last_updated_fmt = '%b %d, %Y'
149 # If true, SmartyPants will be used to convert quotes and dashes to
150 # typographically correct entities.
151 #html_use_smartypants = True
153 # Custom sidebar templates, maps document names to template names.
156 # Additional templates that should be rendered to pages, maps page names to
158 #html_additional_pages = {}
160 # If false, no module index is generated.
161 #html_domain_indices = True
163 # If false, no index is generated.
164 #html_use_index = True
166 # If true, the index is split into individual pages for each letter.
167 #html_split_index = False
169 # If true, links to the reST sources are added to the pages.
170 #html_show_sourcelink = True
172 # If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
173 #html_show_sphinx = True
175 # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
176 #html_show_copyright = True
178 # If true, an OpenSearch description file will be output, and all pages will
179 # contain a <link> tag referring to it. The value of this option must be the
180 # base URL from which the finished HTML is served.
181 #html_use_opensearch = ''
183 # This is the file name suffix for HTML files (e.g. ".xhtml").
184 #html_file_suffix = None
186 # Output file base name for HTML help builder.
187 htmlhelp_basename = 'ShaperpythonAPIdoc'
190 # -- Options for LaTeX output ---------------------------------------------
193 # The paper size ('letterpaper' or 'a4paper').
194 #'papersize': 'letterpaper',
196 # The font size ('10pt', '11pt' or '12pt').
197 #'pointsize': '10pt',
199 # Additional stuff for the LaTeX preamble.
203 # Grouping the document tree into LaTeX files. List of tuples
204 # (source start file, target name, title,
205 # author, documentclass [howto, manual, or own class]).
207 ('index', 'ShaperpythonAPI.tex', 'Shaper python API Documentation',
208 'Renaud Nédélec', 'manual'),
211 # The name of an image file (relative to this directory) to place at the top of
215 # For "manual" documents, if this is true, then toplevel headings are parts,
217 #latex_use_parts = False
219 # If true, show page references after internal links.
220 #latex_show_pagerefs = False
222 # If true, show URL addresses after external links.
223 #latex_show_urls = False
225 # Documents to append as an appendix to all manuals.
226 #latex_appendices = []
228 # If false, no module index is generated.
229 #latex_domain_indices = True
232 # -- Options for manual page output ---------------------------------------
234 # One entry per manual page. List of tuples
235 # (source start file, name, description, authors, manual section).
237 ('index', 'shaperpythonapi', 'Shaper python API Documentation',
238 ['Renaud Nédélec'], 1)
241 # If true, show URL addresses after external links.
242 #man_show_urls = False
245 # -- Options for Texinfo output -------------------------------------------
247 # Grouping the document tree into Texinfo files. List of tuples
248 # (source start file, target name, title, author,
249 # dir menu entry, description, category)
250 texinfo_documents = [
251 ('index', 'ShaperpythonAPI', 'Shaper python API Documentation',
252 'Renaud Nédélec', 'ShaperpythonAPI', 'One line description of project.',
256 # Documents to append as an appendix to all manuals.
257 #texinfo_appendices = []
259 # If false, no module index is generated.
260 #texinfo_domain_indices = True
262 # How to display URL addresses: 'footnote', 'no', or 'inline'.
263 #texinfo_show_urls = 'footnote'
265 # If true, do not generate a @detailmenu in the "Top" node's menu.
266 #texinfo_no_detailmenu = False
268 autodoc_member_order = 'bysource'