|
1
|
|
|
# -*- coding: utf-8 -*- |
|
2
|
|
|
from __future__ import unicode_literals |
|
3
|
|
|
|
|
4
|
|
|
import os |
|
5
|
|
|
|
|
6
|
|
|
|
|
7
|
|
|
extensions = [ |
|
8
|
|
|
'sphinx.ext.autodoc', |
|
9
|
|
|
'sphinx.ext.autosummary', |
|
10
|
|
|
'sphinx.ext.coverage', |
|
11
|
|
|
'sphinx.ext.doctest', |
|
12
|
|
|
'sphinx.ext.extlinks', |
|
13
|
|
|
'sphinx.ext.ifconfig', |
|
14
|
|
|
'sphinx.ext.napoleon', |
|
15
|
|
|
'sphinx.ext.todo', |
|
16
|
|
|
'sphinx.ext.viewcode', |
|
17
|
|
|
'numpydoc.numpydoc' |
|
18
|
|
|
] |
|
19
|
|
|
|
|
20
|
|
|
# Whether to create a Sphinx table of contents for the lists of class methods |
|
21
|
|
|
# and attributes. If a table of contents is made, Sphinx expects each entry |
|
22
|
|
|
# to have a separate page. True by default. |
|
23
|
|
|
numpydoc_class_members_toctree = False |
|
24
|
|
|
|
|
25
|
|
|
if os.getenv('SPELLCHECK'): |
|
26
|
|
|
extensions += 'sphinxcontrib.spelling', |
|
27
|
|
|
spelling_show_suggestions = True |
|
28
|
|
|
spelling_lang = 'en_US' |
|
29
|
|
|
|
|
30
|
|
|
source_suffix = ['.rst', '.md'] |
|
31
|
|
|
master_doc = 'index' |
|
32
|
|
|
project = 'AIscalator' |
|
33
|
|
|
year = '2018' |
|
34
|
|
|
author = 'Christophe Duong' |
|
35
|
|
|
copyright = '{0}, {1}'.format(year, author) |
|
36
|
|
|
version = release = '0.1.18' |
|
37
|
|
|
|
|
38
|
|
|
pygments_style = 'trac' |
|
39
|
|
|
# Add any paths that contain templates here, relative to this directory. |
|
40
|
|
|
templates_path = ['_templates'] |
|
41
|
|
|
extlinks = { |
|
42
|
|
|
'issue': ('https://github.com/Aiscalate/aiscalator/issues/%s', '#'), |
|
43
|
|
|
'pr': ('https://github.com/Aiscalate/aiscalator/pull/%s', 'PR #'), |
|
44
|
|
|
} |
|
45
|
|
|
import sphinx_py3doc_enhanced_theme |
|
46
|
|
|
html_theme = "sphinx_py3doc_enhanced_theme" |
|
47
|
|
|
html_theme_path = [sphinx_py3doc_enhanced_theme.get_html_theme_path()] |
|
48
|
|
|
html_theme_options = { |
|
49
|
|
|
'githuburl': 'https://github.com/Aiscalate/aiscalator/' |
|
50
|
|
|
} |
|
51
|
|
|
|
|
52
|
|
|
# Add any paths that contain custom static files (such as style sheets) here, |
|
53
|
|
|
# relative to this directory. They are copied after the builtin static files, |
|
54
|
|
|
# so a file named "default.css" will overwrite the builtin "default.css". |
|
55
|
|
|
html_static_path = ['_static'] |
|
56
|
|
|
|
|
57
|
|
|
html_use_smartypants = True |
|
58
|
|
|
html_last_updated_fmt = '%b %d, %Y' |
|
59
|
|
|
html_split_index = False |
|
60
|
|
|
html_sidebars = { |
|
61
|
|
|
'**': ['searchbox.html', 'globaltoc.html', 'sourcelink.html'], |
|
62
|
|
|
} |
|
63
|
|
|
html_short_title = '%s-%s' % (project, version) |
|
64
|
|
|
|
|
65
|
|
|
napoleon_use_ivar = True |
|
66
|
|
|
napoleon_use_rtype = False |
|
67
|
|
|
napoleon_use_param = False |
|
68
|
|
|
|
Aiscalate /
aiscalator
