|
1
|
|
|
import sphinx_bootstrap_theme |
|
2
|
|
|
|
|
3
|
|
|
html_css_files = [ |
|
4
|
|
|
"https://cdn.jsdelivr.net/gh/ickc/markdown-latex-css/css/_table.min.css", |
|
5
|
|
|
"https://cdn.jsdelivr.net/gh/ickc/markdown-latex-css/fonts/fonts.min.css", |
|
6
|
|
|
] |
|
7
|
|
|
|
|
8
|
|
|
extensions = [ |
|
9
|
|
|
"sphinx.ext.autodoc", |
|
10
|
|
|
"sphinx.ext.autosummary", |
|
11
|
|
|
"sphinx.ext.coverage", |
|
12
|
|
|
"sphinx.ext.doctest", |
|
13
|
|
|
"sphinx.ext.extlinks", |
|
14
|
|
|
"sphinx.ext.ifconfig", |
|
15
|
|
|
"sphinx.ext.napoleon", |
|
16
|
|
|
"sphinx.ext.todo", |
|
17
|
|
|
"sphinx.ext.viewcode", |
|
18
|
|
|
"nbsphinx", |
|
19
|
|
|
"sphinxcontrib.apidoc", |
|
20
|
|
|
] |
|
21
|
|
|
source_suffix = ".rst" |
|
22
|
|
|
master_doc = "index" |
|
23
|
|
|
project = "pannb" |
|
24
|
|
|
year = "2021" |
|
25
|
|
|
author = "Kolen Cheung" |
|
26
|
|
|
copyright = f"{year}, {author}" |
|
27
|
|
|
version = release = "0.1.3" |
|
28
|
|
|
|
|
29
|
|
|
pygments_style = "solarized-light" |
|
30
|
|
|
html_theme = "bootstrap" |
|
31
|
|
|
html_theme_path = sphinx_bootstrap_theme.get_html_theme_path() |
|
32
|
|
|
html_theme_options = { |
|
33
|
|
|
"navbar_links": [ |
|
34
|
|
|
( |
|
35
|
|
|
"GitHub", |
|
36
|
|
|
"https://github.com/ickc/pannb/", |
|
37
|
|
|
True, |
|
38
|
|
|
) |
|
39
|
|
|
], |
|
40
|
|
|
"source_link_position": None, |
|
41
|
|
|
"bootswatch_theme": "readable", |
|
42
|
|
|
"bootstrap_version": "3", |
|
43
|
|
|
} |
|
44
|
|
|
|
|
45
|
|
|
html_use_smartypants = True |
|
46
|
|
|
html_last_updated_fmt = "%b %d, %Y" |
|
47
|
|
|
html_split_index = False |
|
48
|
|
|
html_short_title = f"{project}-{version}" |
|
49
|
|
|
|
|
50
|
|
|
napoleon_use_ivar = True |
|
51
|
|
|
napoleon_use_rtype = False |
|
52
|
|
|
napoleon_use_param = False |
|
53
|
|
|
|
|
54
|
|
|
# math_number_all = True |
|
55
|
|
|
|
|
56
|
|
|
mathjax_path_lut = { |
|
57
|
|
|
"jsdelivr": "https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-chtml-full.js", |
|
58
|
|
|
"unpkg": "https://www.unpkg.com/mathjax@3/es5/tex-chtml-full.js", |
|
59
|
|
|
"cloudflare": "https://cdnjs.cloudflare.com/ajax/libs/mathjax/3.2.0/es5/tex-chtml-full.js", |
|
60
|
|
|
"githack": "https://rawcdn.githack.com/mathjax/MathJax/3.2.0/es5/tex-chtml-full.js", |
|
61
|
|
|
"statically": "https://cdn.statically.io/gh/mathjax/MathJax/3.2.0/es5/tex-chtml-full.js", |
|
62
|
|
|
} |
|
63
|
|
|
|
|
64
|
|
|
mathjax_path = mathjax_path_lut["jsdelivr"] |
|
65
|
|
|
|
|
66
|
|
|
mathjax3_config = { |
|
67
|
|
|
"loader": { |
|
68
|
|
|
"load": [ |
|
69
|
|
|
# "[tex]/physics", |
|
70
|
|
|
"[tex]/mathtools", |
|
71
|
|
|
"[tex]/empheq", |
|
72
|
|
|
] |
|
73
|
|
|
}, |
|
74
|
|
|
"tex": { |
|
75
|
|
|
"packages": { |
|
76
|
|
|
"[+]": [ |
|
77
|
|
|
# "physics", |
|
78
|
|
|
"mathtools", |
|
79
|
|
|
"empheq", |
|
80
|
|
|
], |
|
81
|
|
|
}, |
|
82
|
|
|
"tags": "ams", |
|
83
|
|
|
}, |
|
84
|
|
|
} |
|
85
|
|
|
|
|
86
|
|
|
# sphinxcontrib.apidoc |
|
87
|
|
|
apidoc_module_dir = "../src/pannb" |
|
88
|
|
|
apidoc_separate_modules = True |
|
89
|
|
|
apidoc_module_first = True |
|
90
|
|
|
|
ickc /
pannb
