Debian Codegraph @

doc/conf.py

raw
1 #!/usr/bin/env python3
2 # -*- coding: utf-8 -*-
3 #
4 # Orange3 Example Add-on documentation build configuration file, created by
5 # sphinx-quickstart on Fri Aug 21 11:28:31 2015.
6 #
7 # This file is execfile()d with the current directory set to its
8 # containing dir.
9 #
10 # Note that not all possible configuration values are present in this
11 # autogenerated file.
12 #
13 # All configuration values have a default; values that are commented out
14 # serve to show the default.
15
16 import sys
17 import os
18
19 # General information about the project.
20 project = "processview"
21 copyright = "2016-2021, ESRF"
22 author = "ESRF"
23
24 # -- General configuration ------------------------------------------------
25
26 # If your documentation needs a minimal Sphinx version, state it here.
27 # needs_sphinx = '1.0'
28
29 # Add any Sphinx extension module names here, as strings. They can be
30 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
31 # ones.
32 extensions = [
33 "sphinx.ext.autodoc",
34 "nbsphinx",
35 ]
36
37 # Add any paths that contain templates here, relative to this directory.
38 templates_path = ["templates"]
39
40 # The suffix(es) of source filenames.
41 # You can specify multiple suffix as a list of string:
42 source_suffix = [".rst", ".md"]
43
44 # The encoding of source files.
45 # source_encoding = 'utf-8-sig'
46
47 # The master toctree document.
48 master_doc = "index"
49
50 # The version info for the project you're documenting, acts as replacement for
51 # |version| and |release|, also used in various other places throughout the
52 # built documents.
53 #
54 # The short X.Y version.
55 version = "1.2"
56 # The full version, including alpha/beta/rc tags.
57 release = "1.2"
58
59 # The language for content autogenerated by Sphinx. Refer to documentation
60 # for a list of supported languages.
61 #
62 # This is also used if you do content translation via gettext catalogs.
63 # Usually you set "language" from the command line for these cases.
64 language = None
65
66 # There are two options for replacing |today|: either, you set today to some
67 # non-false value, then it is used:
68 # today = ''
69 # Else, today_fmt is used as the format for a strftime call.
70 # today_fmt = '%B %d, %Y'
71
72 # List of patterns, relative to source directory, that match files and
73 # directories to ignore when looking for source files.
74 exclude_patterns = ["build", "**.ipynb_checkpoints"]
75
76 # The reST default role (used for this markup: `text`) to use for all
77 # documents.
78 # default_role = None
79
80 # If true, '()' will be appended to :func: etc. cross-reference text.
81 # add_function_parentheses = True
82
83 # If true, the current module name will be prepended to all description
84 # unit titles (such as .. function::).
85 # add_module_names = True
86
87 # If true, sectionauthor and moduleauthor directives will be shown in the
88 # output. They are ignored by default.
89 # show_authors = False
90
91 # The name of the Pygments (syntax highlighting) style to use.
92 pygments_style = "sphinx"
93
94 # A list of ignored prefixes for module index sorting.
95 # modindex_common_prefix = []
96
97 # If true, keep warnings as "system message" paragraphs in the built documents.
98 # keep_warnings = False
99
100 # If true, `todo` and `todoList` produce output, else they produce nothing.
101 todo_include_todos = False
102
103
104 # -- Options for HTML output ----------------------------------------------
105
106 # The theme to use for HTML and HTML Help pages. See the documentation for
107 # a list of builtin themes.
108 html_theme = "nature"
109
110 # Theme options are theme-specific and customize the look and feel of a theme
111 # further. For a list of options available for each theme, see the
112 # documentation.
113 # html_theme_options = {}
114
115 # Add any paths that contain custom themes here, relative to this directory.
116 # html_theme_path = []
117
118 # The name for this set of Sphinx documents. If None, it defaults to
119 # "<project> v<release> documentation".
120 # html_title = None
121
122 # A shorter title for the navigation bar. Default is the same as html_title.
123 # html_short_title = None
124
125 # The name of an image file (relative to this directory) to place at the top
126 # of the sidebar.
127 html_logo = "img/processview.png"
128
129 # The name of an image file (within the static path) to use as favicon of the
130 # docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
131 # pixels large.
132 # html_favicon = None
133
134 # Add any paths that contain custom static files (such as style sheets) here,
135 # relative to this directory. They are copied after the builtin static files,
136 # so a file named "default.css" will overwrite the builtin "default.css".
137 # html_static_path = ['static']
138
139 # Add any extra paths that contain custom files (such as robots.txt or
140 # .htaccess) here, relative to this directory. These files are copied
141 # directly to the root of the documentation.
142 # html_extra_path = []
143
144 # If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
145 # using the given strftime format.
146 # html_last_updated_fmt = '%b %d, %Y'
147
148 # If true, SmartyPants will be used to convert quotes and dashes to
149 # typographically correct entities.
150 # html_use_smartypants = True
151
152 # Custom sidebar templates, maps document names to template names.
153 # html_sidebars = {}
154
155 # Additional templates that should be rendered to pages, maps page names to
156 # template names.
157 # html_additional_pages = {}
158
159 # If false, no module index is generated.
160 # html_domain_indices = True
161
162 # If false, no index is generated.
163 # html_use_index = True
164
165 # If true, the index is split into individual pages for each letter.
166 # html_split_index = False
167
168 # If true, links to the reST sources are added to the pages.
169 # html_show_sourcelink = True
170
171 # If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
172 # html_show_sphinx = True
173
174 # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
175 # html_show_copyright = True
176
177 # If true, an OpenSearch description file will be output, and all pages will
178 # contain a <link> tag referring to it. The value of this option must be the
179 # base URL from which the finished HTML is served.
180 # html_use_opensearch = ''
181
182 # This is the file name suffix for HTML files (e.g. ".xhtml").
183 # html_file_suffix = None
184
185 # Language to be used for generating the HTML full-text search index.
186 # Sphinx supports the following languages:
187 # 'da', 'de', 'en', 'es', 'fi', 'fr', 'h', 'it', 'ja'
188 # 'nl', 'no', 'pt', 'ro', 'r', 'sv', 'tr'
189 # html_search_language = 'en'
190
191 # A dictionary with options for the search language support, empty by default.
192 # Now only 'ja' uses this config value
193 # html_search_options = {'type': 'default'}
194
195 # The name of a javascript file (relative to the configuration directory) that
196 # implements a search results scorer. If empty, the default will be used.
197 # html_search_scorer = 'scorer.js'
198
199 # Output file base name for HTML help builder.
200 htmlhelp_basename = "processview"
201
202 # -- Options for LaTeX output ---------------------------------------------
203
204 latex_elements = {
205 # The paper size ('letterpaper' or 'a4paper').
206 # 'papersize': 'letterpaper',
207 # The font size ('10pt', '11pt' or '12pt').
208 # 'pointsize': '10pt',
209 # Additional stuff for the LaTeX preamble.
210 # 'preamble': '',
211 # Latex figure (float) alignment
212 # 'figure_align': 'htbp',
213 }
214
215 # Grouping the document tree into LaTeX files. List of tuples
216 # (source start file, target name, title,
217 # author, documentclass [howto, manual, or own class]).
218 # latex_documents = [
219 # (master_doc, 'Orange3ESRFAdd-on.tex', 'Orange3 ESRF Add-on Documentation',
220 # 'Biolab', 'manual'),
221 # ]
222
223 # The name of an image file (relative to this directory) to place at the top of
224 # the title page.
225 # latex_logo = None
226
227 # For "manual" documents, if this is true, then toplevel headings are parts,
228 # not chapters.
229 # latex_use_parts = False
230
231 # If true, show page references after internal links.
232 # latex_show_pagerefs = False
233
234 # If true, show URL addresses after external links.
235 # latex_show_urls = False
236
237 # Documents to append as an appendix to all manuals.
238 # latex_appendices = []
239
240 # If false, no module index is generated.
241 # latex_domain_indices = True
242
243
244 # -- Options for manual page output ---------------------------------------
245
246 # One entry per manual page. List of tuples
247 # (source start file, name, description, authors, manual section).
248 man_pages = [(master_doc, "processview", [author], 1)]
249
250 htmlhelp_pages = [(master_doc, "processview", [author], 1)]
251
252 # If true, show URL addresses after external links.
253 # man_show_urls = False
254
255
256 # -- Options for Texinfo output -------------------------------------------
257
258 # Grouping the document tree into Texinfo files. List of tuples
259 # (source start file, target name, title, author,
260 # dir menu entry, description, category)
261 texinfo_documents = [
262 (
263 master_doc,
264 "processview",
265 "processview Documentation",
266 author,
267 "processview",
268 "One line description of project.",
269 "Miscellaneous",
270 )
271 ]
272
273 # Documents to append as an appendix to all manuals.
274 # texinfo_appendices = []
275
276 # If false, no module index is generated.
277 # texinfo_domain_indices = True
278
279 # How to display URL addresses: 'footnote', 'no', or 'inline'.
280 # texinfo_show_urls = 'footnote'
281
282 # If true, do not generate a @detailmenu in the "Top" node's menu.
283 # texinfo_no_detailmenu = False
284
285
286 nbsphinx_allow_errors = True
287 nbsphinx_timeout = 60