1 # -*- coding: utf-8 -*-
3 ## Copyright (C) 2014-2017 CEA/DEN, EDF R&D
5 ## This library is free software; you can redistribute it and/or
6 ## modify it under the terms of the GNU Lesser General Public
7 ## License as published by the Free Software Foundation; either
8 ## version 2.1 of the License, or (at your option) any later version.
10 ## This library is distributed in the hope that it will be useful,
11 ## but WITHOUT ANY WARRANTY; without even the implied warranty of
12 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 ## Lesser General Public License for more details.
15 ## You should have received a copy of the GNU Lesser General Public
16 ## License along with this library; if not, write to the Free Software
17 ## Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
19 ## See http:##www.salome-platform.org/ or
20 ## email : webmaster.salome@opencascade.com<mailto:webmaster.salome@opencascade.com>
24 # Shaper python API documentation build configuration file, created by
25 # sphinx-quickstart on Thu Oct 15 11:55:42 2015.
27 # This file is execfile()d with the current directory set to its
30 # Note that not all possible configuration values are present in this
33 # All configuration values have a default; values that are commented out
34 # serve to show the default.
39 # If extensions (or modules to document with autodoc) are in another directory,
40 # add these directories to sys.path here. If the directory is relative to the
41 # documentation root, use os.path.abspath to make it absolute, like shown here.
42 sys.path.insert(0, os.path.abspath('..'))
43 sys.path.insert(0, os.path.abspath('../..'))
44 sys.path.insert(0, os.path.abspath('../../..'))
46 # -- General configuration ------------------------------------------------
48 # If your documentation needs a minimal Sphinx version, state it here.
51 # Add any Sphinx extension module names here, as strings. They can be
52 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
58 'sphinx.ext.coverage',
59 'sphinx.ext.viewcode',
60 'sphinx.ext.napoleon',
61 'sphinx.ext.autosummary',
64 # Add any paths that contain templates here, relative to this directory.
65 templates_path = ['_templates']
67 # The suffix of source filenames.
68 source_suffix = '.rst'
70 # The encoding of source files.
71 #source_encoding = 'utf-8-sig'
73 # The master toctree document.
76 # General information about the project.
77 project = u'Shaper python API'
78 copyright = u'2014-20xx CEA/DEN, EDF R&D'
80 # The version info for the project you're documenting, acts as replacement for
81 # |version| and |release|, also used in various other places throughout the
84 # The short X.Y version.
86 # The full version, including alpha/beta/rc tags.
89 # The language for content autogenerated by Sphinx. Refer to documentation
90 # for a list of supported languages.
93 # There are two options for replacing |today|: either, you set today to some
94 # non-false value, then it is used:
96 # Else, today_fmt is used as the format for a strftime call.
97 #today_fmt = '%B %d, %Y'
99 # List of patterns, relative to source directory, that match files and
100 # directories to ignore when looking for source files.
101 exclude_patterns = []
103 # The reST default role (used for this markup: `text`) to use for all
107 # If true, '()' will be appended to :func: etc. cross-reference text.
108 #add_function_parentheses = True
110 # If true, the current module name will be prepended to all description
111 # unit titles (such as .. function::).
112 #add_module_names = True
114 # If true, sectionauthor and moduleauthor directives will be shown in the
115 # output. They are ignored by default.
116 #show_authors = False
118 # The name of the Pygments (syntax highlighting) style to use.
119 pygments_style = 'sphinx'
121 # A list of ignored prefixes for module index sorting.
122 #modindex_common_prefix = []
124 # If true, keep warnings as "system message" paragraphs in the built documents.
125 #keep_warnings = False
128 # -- Options for HTML output ----------------------------------------------
130 # The theme to use for HTML and HTML Help pages. See the documentation for
131 # a list of builtin themes.
132 html_theme = 'default'
134 # Theme options are theme-specific and customize the look and feel of a theme
135 # further. For a list of options available for each theme, see the
137 #html_theme_options = {}
139 # Add any paths that contain custom themes here, relative to this directory.
140 #html_theme_path = []
142 # The name for this set of Sphinx documents. If None, it defaults to
143 # "<project> v<release> documentation".
146 # A shorter title for the navigation bar. Default is the same as html_title.
147 #html_short_title = None
149 # The name of an image file (relative to this directory) to place at the top
153 # The name of an image file (within the static path) to use as favicon of the
154 # docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
158 # Add any paths that contain custom static files (such as style sheets) here,
159 # relative to this directory. They are copied after the builtin static files,
160 # so a file named "default.css" will overwrite the builtin "default.css".
161 html_static_path = ['_static']
163 # Add any extra paths that contain custom files (such as robots.txt or
164 # .htaccess) here, relative to this directory. These files are copied
165 # directly to the root of the documentation.
166 #html_extra_path = []
168 # If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
169 # using the given strftime format.
170 #html_last_updated_fmt = '%b %d, %Y'
172 # If true, SmartyPants will be used to convert quotes and dashes to
173 # typographically correct entities.
174 #html_use_smartypants = True
176 # Custom sidebar templates, maps document names to template names.
179 # Additional templates that should be rendered to pages, maps page names to
181 #html_additional_pages = {}
183 # If false, no module index is generated.
184 #html_domain_indices = True
186 # If false, no index is generated.
187 #html_use_index = True
189 # If true, the index is split into individual pages for each letter.
190 #html_split_index = False
192 # If true, links to the reST sources are added to the pages.
193 #html_show_sourcelink = True
195 # If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
196 #html_show_sphinx = True
198 # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
199 #html_show_copyright = True
201 # If true, an OpenSearch description file will be output, and all pages will
202 # contain a <link> tag referring to it. The value of this option must be the
203 # base URL from which the finished HTML is served.
204 #html_use_opensearch = ''
206 # This is the file name suffix for HTML files (e.g. ".xhtml").
207 #html_file_suffix = None
209 # Output file base name for HTML help builder.
210 htmlhelp_basename = 'ShaperpythonAPIdoc'
213 # -- Options for LaTeX output ---------------------------------------------
216 # The paper size ('letterpaper' or 'a4paper').
217 #'papersize': 'letterpaper',
219 # The font size ('10pt', '11pt' or '12pt').
220 #'pointsize': '10pt',
222 # Additional stuff for the LaTeX preamble.
226 # Grouping the document tree into LaTeX files. List of tuples
227 # (source start file, target name, title,
228 # author, documentclass [howto, manual, or own class]).
230 ('index', 'ShaperpythonAPI.tex', u'Shaper python API Documentation',
231 u'Renaud Nédélec', 'manual'),
234 # The name of an image file (relative to this directory) to place at the top of
238 # For "manual" documents, if this is true, then toplevel headings are parts,
240 #latex_use_parts = False
242 # If true, show page references after internal links.
243 #latex_show_pagerefs = False
245 # If true, show URL addresses after external links.
246 #latex_show_urls = False
248 # Documents to append as an appendix to all manuals.
249 #latex_appendices = []
251 # If false, no module index is generated.
252 #latex_domain_indices = True
255 # -- Options for manual page output ---------------------------------------
257 # One entry per manual page. List of tuples
258 # (source start file, name, description, authors, manual section).
260 ('index', 'shaperpythonapi', u'Shaper python API Documentation',
261 [u'Renaud Nédélec'], 1)
264 # If true, show URL addresses after external links.
265 #man_show_urls = False
268 # -- Options for Texinfo output -------------------------------------------
270 # Grouping the document tree into Texinfo files. List of tuples
271 # (source start file, target name, title, author,
272 # dir menu entry, description, category)
273 texinfo_documents = [
274 ('index', 'ShaperpythonAPI', u'Shaper python API Documentation',
275 u'Renaud Nédélec', 'ShaperpythonAPI', 'One line description of project.',
279 # Documents to append as an appendix to all manuals.
280 #texinfo_appendices = []
282 # If false, no module index is generated.
283 #texinfo_domain_indices = True
285 # How to display URL addresses: 'footnote', 'no', or 'inline'.
286 #texinfo_show_urls = 'footnote'
288 # If true, do not generate a @detailmenu in the "Top" node's menu.
289 #texinfo_no_detailmenu = False
291 autodoc_member_order = 'bysource'