conf.py 1.16 KB
Newer Older
1
import nifty5
Martin Reinecke's avatar
Martin Reinecke committed
2
3
4
5
6
7
8
9
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
10
11
12
autodoc_member_order = 'groupwise'
numpydoc_show_inherited_class_members = False
numpydoc_class_members_toctree = False
Martin Reinecke's avatar
Martin Reinecke committed
13
14

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

Philipp Arras's avatar
Philipp Arras committed
22
project = u'NIFTy5'
Martin Reinecke's avatar
Martin Reinecke committed
23
copyright = u'2013-2018, Max-Planck-Society'
Philipp Arras's avatar
Philipp Arras committed
24
author = u'Martin Reinecke'
25
26
27

release = nifty5.version.__version__
version = release[:-2]
Martin Reinecke's avatar
Martin Reinecke committed
28
29
30

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

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