conf.py 1.16 KB
Newer Older
Martin Reinecke's avatar
Martin Reinecke committed
1
2
3
4
5
6
7
8
import sphinx_rtd_theme

napoleon_google_docstring = False
napoleon_numpy_docstring = True
napoleon_use_ivar = True
napoleon_use_param = False
napoleon_use_keyword = False

Philipp Arras's avatar
Philipp Arras committed
9
10
11
autodoc_member_order = 'groupwise'
numpydoc_show_inherited_class_members = False
numpydoc_class_members_toctree = False
Martin Reinecke's avatar
Martin Reinecke committed
12
13

extensions = [
Philipp Arras's avatar
Philipp Arras committed
14
15
    'sphinx.ext.autodoc', 'numpydoc', 'sphinx.ext.autosummary',
    'sphinx.ext.napoleon', 'sphinx.ext.imgmath', 'sphinx.ext.viewcode'
Martin Reinecke's avatar
Martin Reinecke committed
16
17
18
19
20
]
templates_path = ['_templates']
source_suffix = '.rst'
master_doc = 'index'

Philipp Arras's avatar
Philipp Arras committed
21
project = u'NIFTy5'
Martin Reinecke's avatar
Martin Reinecke committed
22
copyright = u'2013-2018, Max-Planck-Society'
Philipp Arras's avatar
Philipp Arras committed
23
author = u'Martin Reinecke'
Philipp Arras's avatar
Philipp Arras committed
24
# FIXME import version from version.py
Martin Reinecke's avatar
Martin Reinecke committed
25
26
version = u'5.0'
release = u'5.0.0'
Martin Reinecke's avatar
Martin Reinecke committed
27
28
29

language = None
exclude_patterns = []
Martin Reinecke's avatar
tweaks    
Martin Reinecke committed
30
add_module_names = False
Martin Reinecke's avatar
Martin Reinecke committed
31
32
33
34
35
pygments_style = 'sphinx'
todo_include_todos = True

html_theme = "sphinx_rtd_theme"
html_theme_options = {
Philipp Arras's avatar
Philipp Arras committed
36
37
    'collapse_navigation': False,
    'display_version': False,
Martin Reinecke's avatar
Martin Reinecke committed
38
39
}
html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
40
html_logo = 'nifty_logo_black.png'
Martin Reinecke's avatar
Martin Reinecke committed
41
html_static_path = []
Martin Reinecke's avatar
Martin Reinecke committed
42
43
html_last_updated_fmt = '%b %d, %Y'
html_domain_indices = False
44
45
html_use_index = False
html_show_sourcelink = False
Martin Reinecke's avatar
Martin Reinecke committed
46
htmlhelp_basename = 'NIFTydoc'