-
Notifications
You must be signed in to change notification settings - Fork 30
Expand file tree
/
Copy pathconf.py
More file actions
55 lines (47 loc) · 1.47 KB
/
conf.py
File metadata and controls
55 lines (47 loc) · 1.47 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
import os
import sys
import sphinx_bootstrap_theme
import feos
sys.path.append(os.path.abspath(os.path.join(__file__, "../..")))
sys.path.insert(0, os.path.abspath('.'))
# -- Project information -----------------------------------------------------
project = 'feos'
copyright = '2021, Gernot Bauer, Philipp Rehner'
author = 'Gernot Bauer, Philipp Rehner'
release = '0.1.0'
extensions = [
'sphinx.ext.autodoc',
'sphinx.ext.autosummary',
'sphinx.ext.doctest',
'sphinx.ext.mathjax',
'sphinx.ext.githubpages',
'sphinx.ext.napoleon',
'nbsphinx',
]
napoleon_numpy_docstring = True
autodoc_typehints = "both"
autosummary_generate = True
templates_path = ['_templates']
exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store', '**.ipynb_checkpoints']
source_suffix = {
'.rst': 'restructuredtext',
}
# -- Options for HTML output -------------------------------------------------
html_theme = 'bootstrap'
html_theme_options = {
'navbar_sidebarrel': True,
'navbar_pagenav': True,
'navbar_pagenav_name': "Page",
'globaltoc_includehidden': "true",
'navbar_class': "navbar",
'navbar_fixed_top': "true",
'source_link_position': "",
'bootswatch_theme': "paper",
'bootstrap_version': "3",
'navbar_links': [("Python API", "api/index"), ("Python Examples", "examples/index"), ("Rust Guide", "rustguide/index"), ],
}
html_theme_path = sphinx_bootstrap_theme.get_html_theme_path()
html_static_path = ['_static']
html_css_files = [
'style.css',
]