|
14 | 14 |
|
15 | 15 | # Do not warn on external images.
|
16 | 16 | import os
|
| 17 | +import sys |
17 | 18 |
|
18 |
| -suppress_warnings = ['image.nonlocal_uri'] |
| 19 | +sys.path.insert(0, os.path.abspath("..")) |
| 20 | + |
| 21 | +suppress_warnings = ["image.nonlocal_uri"] |
19 | 22 |
|
20 | 23 | # Add any Sphinx extension module names here, as strings. They can be
|
21 | 24 | # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
|
22 | 25 | # ones.
|
23 | 26 | extensions = [
|
24 |
| - 'sphinx.ext.autodoc', |
25 |
| - 'sphinx.ext.coverage', |
26 |
| - 'sphinx.ext.doctest', |
27 |
| - 'sphinx.ext.intersphinx', |
28 |
| - 'sphinx.ext.viewcode', |
| 27 | + "sphinx.ext.autodoc", |
| 28 | + "sphinx.ext.coverage", |
| 29 | + "sphinx.ext.doctest", |
| 30 | + "sphinx.ext.intersphinx", |
| 31 | + "sphinx.ext.viewcode", |
29 | 32 | ]
|
30 | 33 |
|
31 | 34 | # Add any paths that contain templates here, relative to this directory.
|
32 |
| -templates_path = ['_templates'] |
| 35 | +templates_path = ["_templates"] |
33 | 36 |
|
34 | 37 | # The suffix(es) of source filenames.
|
35 | 38 | # You can specify multiple suffix as a list of string:
|
36 | 39 | # source_suffix = ['.rst', '.md']
|
37 |
| -source_suffix = '.rst' |
| 40 | +source_suffix = ".rst" |
38 | 41 |
|
39 | 42 | # The encoding of source files.
|
40 | 43 | # source_encoding = 'utf-8-sig'
|
41 | 44 |
|
42 | 45 | # The master toctree document.
|
43 |
| -master_doc = 'index' |
| 46 | +master_doc = "index" |
44 | 47 |
|
45 | 48 | # General information about the project.
|
46 |
| -project = u'Invenio-SIP2' |
47 |
| -copyright = u'2019, UCLouvain' |
48 |
| -author = u'UCLouvain' |
| 49 | +project = "Invenio-SIP2" |
| 50 | +copyright = "2019, UCLouvain" |
| 51 | +author = "UCLouvain" |
49 | 52 |
|
50 | 53 | # The version info for the project you're documenting, acts as replacement for
|
51 | 54 | # |version| and |release|, also used in various other places throughout the
|
|
55 | 58 |
|
56 | 59 | # Get the version string. Cannot be done with import!
|
57 | 60 | module_data = {}
|
58 |
| -with open(os.path.join(os.path.dirname(__file__), '..', |
59 |
| - 'invenio_sip2', 'version.py'), |
60 |
| - 'rt') as file: |
| 61 | +with open( |
| 62 | + os.path.join(os.path.dirname(__file__), "..", "invenio_sip2", "version.py"), "rt" |
| 63 | +) as file: |
61 | 64 | exec(file.read(), module_data)
|
62 |
| - version = module_data['__version__'] |
| 65 | + version = module_data["__version__"] |
63 | 66 | # The full version, including alpha/beta/rc tags.
|
64 | 67 | release = version
|
65 | 68 |
|
|
68 | 71 | #
|
69 | 72 | # This is also used if you do content translation via gettext catalogs.
|
70 | 73 | # Usually you set "language" from the command line for these cases.
|
71 |
| -language = 'en' |
| 74 | +language = "en" |
72 | 75 |
|
73 | 76 | # There are two options for replacing |today|: either, you set today to some
|
74 | 77 | # non-false value, then it is used:
|
|
96 | 99 | # show_authors = False
|
97 | 100 |
|
98 | 101 | # The name of the Pygments (syntax highlighting) style to use.
|
99 |
| -pygments_style = 'sphinx' |
| 102 | +pygments_style = "sphinx" |
100 | 103 |
|
101 | 104 | # A list of ignored prefixes for module index sorting.
|
102 | 105 | # modindex_common_prefix = []
|
|
109 | 112 |
|
110 | 113 |
|
111 | 114 | # -- Options for HTML output ----------------------------------------------
|
112 |
| -html_theme = 'alabaster' |
| 115 | +html_theme = "alabaster" |
113 | 116 |
|
114 | 117 | html_theme_options = {
|
115 |
| - 'description': 'Library Selfcheck SIP2 module for invenio', |
116 |
| - 'github_user': 'inveniosoftware-contrib', |
117 |
| - 'github_repo': 'invenio-sip2', |
118 |
| - 'github_button': False, |
119 |
| - 'github_banner': True, |
120 |
| - 'show_powered_by': False, |
121 |
| - 'extra_nav_links': { |
122 |
| - 'invenio-sip2@GitHub': |
123 |
| - 'https://github.com/inveniosoftware-contrib/invenio-sip2', |
124 |
| - 'invenio-sip2@PyPI': 'https://pypi.python.org/pypi/invenio-sip2/', |
125 |
| - } |
| 118 | + "description": "Library Selfcheck SIP2 module for invenio", |
| 119 | + "github_user": "inveniosoftware-contrib", |
| 120 | + "github_repo": "invenio-sip2", |
| 121 | + "github_button": False, |
| 122 | + "github_banner": True, |
| 123 | + "show_powered_by": False, |
| 124 | + "extra_nav_links": { |
| 125 | + "invenio-sip2@GitHub": "https://github.com/inveniosoftware-contrib/invenio-sip2", |
| 126 | + "invenio-sip2@PyPI": "https://pypi.python.org/pypi/invenio-sip2/", |
| 127 | + }, |
126 | 128 | }
|
127 | 129 |
|
128 | 130 | # The theme to use for HTML and HTML Help pages. See the documentation for
|
|
172 | 174 |
|
173 | 175 | # Custom sidebar templates, maps document names to template names.
|
174 | 176 | html_sidebars = {
|
175 |
| - '**': [ |
176 |
| - 'about.html', |
177 |
| - 'navigation.html', |
178 |
| - 'relations.html', |
179 |
| - 'searchbox.html', |
180 |
| - 'donate.html', |
| 177 | + "**": [ |
| 178 | + "about.html", |
| 179 | + "navigation.html", |
| 180 | + "relations.html", |
| 181 | + "searchbox.html", |
| 182 | + "donate.html", |
181 | 183 | ]
|
182 | 184 | }
|
183 | 185 |
|
|
226 | 228 | # html_search_scorer = 'scorer.js'
|
227 | 229 |
|
228 | 230 | # Output file base name for HTML help builder.
|
229 |
| -htmlhelp_basename = 'invenio-sip2_namedoc' |
| 231 | +htmlhelp_basename = "invenio-sip2_namedoc" |
230 | 232 |
|
231 | 233 | # -- Options for LaTeX output ---------------------------------------------
|
232 | 234 |
|
233 | 235 | latex_elements = {
|
234 | 236 | # The paper size ('letterpaper' or 'a4paper').
|
235 | 237 | # 'papersize': 'letterpaper',
|
236 |
| - |
237 | 238 | # The font size ('10pt', '11pt' or '12pt').
|
238 | 239 | # 'pointsize': '10pt',
|
239 |
| - |
240 | 240 | # Additional stuff for the LaTeX preamble.
|
241 | 241 | # 'preamble': '',
|
242 |
| - |
243 | 242 | # Latex figure (float) alignment
|
244 | 243 | # 'figure_align': 'htbp',
|
245 | 244 | }
|
|
248 | 247 | # (source start file, target name, title,
|
249 | 248 | # author, documentclass [howto, manual, or own class]).
|
250 | 249 | latex_documents = [
|
251 |
| - (master_doc, 'invenio-sip2.tex', u'invenio-sip2 Documentation', |
252 |
| - u'UCLouvain', 'manual'), |
| 250 | + ( |
| 251 | + master_doc, |
| 252 | + "invenio-sip2.tex", |
| 253 | + "invenio-sip2 Documentation", |
| 254 | + "UCLouvain", |
| 255 | + "manual", |
| 256 | + ), |
253 | 257 | ]
|
254 | 258 |
|
255 | 259 | # The name of an image file (relative to this directory) to place at the top of
|
|
277 | 281 |
|
278 | 282 | # One entry per manual page. List of tuples
|
279 | 283 | # (source start file, name, description, authors, manual section).
|
280 |
| -man_pages = [ |
281 |
| - (master_doc, 'invenio-sip2', u'invenio-sip2 Documentation', |
282 |
| - [author], 1) |
283 |
| -] |
| 284 | +man_pages = [(master_doc, "invenio-sip2", "invenio-sip2 Documentation", [author], 1)] |
284 | 285 |
|
285 | 286 | # If true, show URL addresses after external links.
|
286 | 287 | # man_show_urls = False
|
|
292 | 293 | # (source start file, target name, title, author,
|
293 | 294 | # dir menu entry, description, category)
|
294 | 295 | texinfo_documents = [
|
295 |
| - (master_doc, 'invenio-sip2', u'Invenio-SIP2 Documentation', |
296 |
| - author, 'invenio-sip2', 'Library Selfcheck SIP2 module for invenio', |
297 |
| - 'Miscellaneous'), |
| 296 | + ( |
| 297 | + master_doc, |
| 298 | + "invenio-sip2", |
| 299 | + "Invenio-SIP2 Documentation", |
| 300 | + author, |
| 301 | + "invenio-sip2", |
| 302 | + "Library Selfcheck SIP2 module for invenio", |
| 303 | + "Miscellaneous", |
| 304 | + ), |
298 | 305 | ]
|
299 | 306 |
|
300 | 307 | # Documents to append as an appendix to all manuals.
|
|
312 | 319 |
|
313 | 320 | # Example configuration for intersphinx: refer to the Python standard library.
|
314 | 321 | intersphinx_mapping = {
|
315 |
| - 'python': ('https://docs.python.org/', None), |
| 322 | + "python": ("https://docs.python.org/", None), |
316 | 323 | # TODO: Configure external documentation references, eg:
|
317 | 324 | # 'Flask-Admin': ('https://flask-admin.readthedocs.io/en/latest/', None),
|
318 | 325 | }
|
319 | 326 |
|
320 | 327 | # Autodoc configuraton.
|
321 |
| -autoclass_content = 'both' |
| 328 | +autoclass_content = "both" |
0 commit comments