conf.py 9.24 KB
Newer Older
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
#!/usr/bin/env python3
# -*- coding: utf-8 -*-
#
# Orange3 Example Add-on documentation build configuration file, created by
# sphinx-quickstart on Fri Aug 21 11:28:31 2015.
#
# This file is execfile()d with the current directory set to its
# containing dir.
#
# Note that not all possible configuration values are present in this
# autogenerated file.
#
# All configuration values have a default; values that are commented out
# serve to show the default.

import sys
import os

payno's avatar
payno committed
19
sys.path.append(os.path.join(os.path.dirname(os.path.abspath(__file__)), "ext"))
20
21
22
23
24
25
26
27
28
29


# If extensions (or modules to document with autodoc) are in another directory,
# add these directories to sys.path here. If the directory is relative to the
# documentation root, use os.path.abspath to make it absolute, like shown here.
# sys.path.insert(0, os.path.abspath('.'))

# -- General configuration ------------------------------------------------

# If your documentation needs a minimal Sphinx version, state it here.
payno's avatar
payno committed
30
# needs_sphinx = '1.0'
31
32
33
34

# Add any Sphinx extension module names here, as strings. They can be
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones.
payno's avatar
payno committed
35
36
extensions = [
    "sphinx.ext.autodoc",
37
38
    "sphinx.ext.autosummary",
    "sphinx.ext.intersphinx",
payno's avatar
payno committed
39
    "nbsphinx",
payno's avatar
payno committed
40
]
41
42

# Add any paths that contain templates here, relative to this directory.
43
templates_path = ["_templates"]
44
45
46
47

# The suffix(es) of source filenames.
# You can specify multiple suffix as a list of string:
# source_suffix = ['.rst', '.md']
payno's avatar
payno committed
48
49
source_suffix = [".rst", ".md"]
# source_parsers = {".md": "recommonmark.parser.CommonMarkParser"}
50
51

# The encoding of source files.
payno's avatar
payno committed
52
# source_encoding = 'utf-8-sig'
53
54

# The master toctree document.
payno's avatar
payno committed
55
master_doc = "index"
56
57

# General information about the project.
payno's avatar
payno committed
58
project = "est"
payno's avatar
payno committed
59
copyright = "2016-2021, ESRF"
payno's avatar
payno committed
60
author = "ESRF"
61
62
63
64
65
66

# The version info for the project you're documenting, acts as replacement for
# |version| and |release|, also used in various other places throughout the
# built documents.
#
# The short X.Y version.
payno's avatar
payno committed
67
version = "0.4"
68
# The full version, including alpha/beta/rc tags.
payno's avatar
payno committed
69
release = "0.4"
70
71
72
73
74
75
76
77
78
79

# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
#
# This is also used if you do content translation via gettext catalogs.
# Usually you set "language" from the command line for these cases.
language = None

# There are two options for replacing |today|: either, you set today to some
# non-false value, then it is used:
payno's avatar
payno committed
80
# today = ''
81
# Else, today_fmt is used as the format for a strftime call.
payno's avatar
payno committed
82
# today_fmt = '%B %d, %Y'
83
84
85

# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
payno's avatar
payno committed
86
exclude_patterns = ["build"]
87
88
89

# The reST default role (used for this markup: `text`) to use for all
# documents.
payno's avatar
payno committed
90
# default_role = None
91
92

# If true, '()' will be appended to :func: etc. cross-reference text.
payno's avatar
payno committed
93
# add_function_parentheses = True
94
95
96

# If true, the current module name will be prepended to all description
# unit titles (such as .. function::).
payno's avatar
payno committed
97
# add_module_names = True
98
99
100

# If true, sectionauthor and moduleauthor directives will be shown in the
# output. They are ignored by default.
payno's avatar
payno committed
101
# show_authors = False
102
103

# The name of the Pygments (syntax highlighting) style to use.
payno's avatar
payno committed
104
pygments_style = "sphinx"
105
106

# A list of ignored prefixes for module index sorting.
payno's avatar
payno committed
107
# modindex_common_prefix = []
108
109

# If true, keep warnings as "system message" paragraphs in the built documents.
payno's avatar
payno committed
110
# keep_warnings = False
111
112
113
114
115
116
117
118
119

# If true, `todo` and `todoList` produce output, else they produce nothing.
todo_include_todos = False


# -- Options for HTML output ----------------------------------------------

# The theme to use for HTML and HTML Help pages.  See the documentation for
# a list of builtin themes.
payno's avatar
payno committed
120
html_theme = "nature"
121
122
123
124

# Theme options are theme-specific and customize the look and feel of a theme
# further.  For a list of options available for each theme, see the
# documentation.
payno's avatar
payno committed
125
# html_theme_options = {}
126
127

# Add any paths that contain custom themes here, relative to this directory.
payno's avatar
payno committed
128
# html_theme_path = []
129
130
131

# The name for this set of Sphinx documents.  If None, it defaults to
# "<project> v<release> documentation".
payno's avatar
payno committed
132
# html_title = None
133
134

# A shorter title for the navigation bar.  Default is the same as html_title.
payno's avatar
payno committed
135
# html_short_title = None
136
137
138

# The name of an image file (relative to this directory) to place at the top
# of the sidebar.
139
html_logo = "img/icon_medium.svg"
140
141
142
143

# The name of an image file (within the static path) to use as favicon of the
# docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32
# pixels large.
payno's avatar
payno committed
144
# html_favicon = None
145
146
147
148
149
150
151
152
153

# Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files,
# so a file named "default.css" will overwrite the builtin "default.css".
# html_static_path = ['static']

# Add any extra paths that contain custom files (such as robots.txt or
# .htaccess) here, relative to this directory. These files are copied
# directly to the root of the documentation.
payno's avatar
payno committed
154
# html_extra_path = []
155
156
157

# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
# using the given strftime format.
payno's avatar
payno committed
158
# html_last_updated_fmt = '%b %d, %Y'
159
160
161

# If true, SmartyPants will be used to convert quotes and dashes to
# typographically correct entities.
payno's avatar
payno committed
162
# html_use_smartypants = True
163
164

# Custom sidebar templates, maps document names to template names.
payno's avatar
payno committed
165
# html_sidebars = {}
166
167
168

# Additional templates that should be rendered to pages, maps page names to
# template names.
payno's avatar
payno committed
169
# html_additional_pages = {}
170
171

# If false, no module index is generated.
payno's avatar
payno committed
172
# html_domain_indices = True
173
174

# If false, no index is generated.
payno's avatar
payno committed
175
# html_use_index = True
176
177

# If true, the index is split into individual pages for each letter.
payno's avatar
payno committed
178
# html_split_index = False
179
180

# If true, links to the reST sources are added to the pages.
payno's avatar
payno committed
181
# html_show_sourcelink = True
182
183

# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
payno's avatar
payno committed
184
# html_show_sphinx = True
185
186

# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
payno's avatar
payno committed
187
# html_show_copyright = True
188
189
190
191

# If true, an OpenSearch description file will be output, and all pages will
# contain a <link> tag referring to it.  The value of this option must be the
# base URL from which the finished HTML is served.
payno's avatar
payno committed
192
# html_use_opensearch = ''
193
194

# This is the file name suffix for HTML files (e.g. ".xhtml").
payno's avatar
payno committed
195
# html_file_suffix = None
196
197
198
199
200

# Language to be used for generating the HTML full-text search index.
# Sphinx supports the following languages:
#   'da', 'de', 'en', 'es', 'fi', 'fr', 'h', 'it', 'ja'
#   'nl', 'no', 'pt', 'ro', 'r', 'sv', 'tr'
payno's avatar
payno committed
201
# html_search_language = 'en'
202
203
204

# A dictionary with options for the search language support, empty by default.
# Now only 'ja' uses this config value
payno's avatar
payno committed
205
# html_search_options = {'type': 'default'}
206
207
208

# The name of a javascript file (relative to the configuration directory) that
# implements a search results scorer. If empty, the default will be used.
payno's avatar
payno committed
209
# html_search_scorer = 'scorer.js'
210
211

# Output file base name for HTML help builder.
payno's avatar
payno committed
212
htmlhelp_basename = "est"
213
214
215
216

# -- Options for LaTeX output ---------------------------------------------

latex_elements = {
payno's avatar
payno committed
217
218
219
220
221
222
223
224
    # The paper size ('letterpaper' or 'a4paper').
    # 'papersize': 'letterpaper',
    # The font size ('10pt', '11pt' or '12pt').
    # 'pointsize': '10pt',
    # Additional stuff for the LaTeX preamble.
    # 'preamble': '',
    # Latex figure (float) alignment
    # 'figure_align': 'htbp',
225
226
227
228
}

# The name of an image file (relative to this directory) to place at the top of
# the title page.
payno's avatar
payno committed
229
# latex_logo = None
230
231
232

# For "manual" documents, if this is true, then toplevel headings are parts,
# not chapters.
payno's avatar
payno committed
233
# latex_use_parts = False
234
235

# If true, show page references after internal links.
payno's avatar
payno committed
236
# latex_show_pagerefs = False
237
238

# If true, show URL addresses after external links.
payno's avatar
payno committed
239
# latex_show_urls = False
240
241

# Documents to append as an appendix to all manuals.
payno's avatar
payno committed
242
# latex_appendices = []
243
244

# If false, no module index is generated.
payno's avatar
payno committed
245
# latex_domain_indices = True
246
247
248
249
250
251


# -- Options for manual page output ---------------------------------------

# One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section).
payno's avatar
payno committed
252
man_pages = [(master_doc, "est", "est Documentation", [author], 1)]
253

payno's avatar
payno committed
254
htmlhelp_pages = [(master_doc, "est", "est Add-on Documentation", [author], 1)]
255
256

# If true, show URL addresses after external links.
payno's avatar
payno committed
257
# man_show_urls = False
258
259
260
261
262
263
264
265


# -- Options for Texinfo output -------------------------------------------

# Grouping the document tree into Texinfo files. List of tuples
# (source start file, target name, title, author,
#  dir menu entry, description, category)
texinfo_documents = [
payno's avatar
payno committed
266
267
268
269
270
271
272
273
274
    (
        master_doc,
        "est",
        "est Documentation",
        author,
        "est",
        "One line description of project.",
        "Miscellaneous",
    )
275
276
277
]

# Documents to append as an appendix to all manuals.
payno's avatar
payno committed
278
# texinfo_appendices = []
279
280

# If false, no module index is generated.
payno's avatar
payno committed
281
# texinfo_domain_indices = True
282
283

# How to display URL addresses: 'footnote', 'no', or 'inline'.
payno's avatar
payno committed
284
# texinfo_show_urls = 'footnote'
285
286

# If true, do not generate a @detailmenu in the "Top" node's menu.
payno's avatar
payno committed
287
# texinfo_no_detailmenu = False
288
289
290
291
292
293
294
295

autosummary_generate = True

autodoc_default_flags = [
    "members",
    "undoc-members",
    "show-inheritance",
]