conf.py 898 Bytes
Newer Older
Martin Reinecke's avatar
5->6    
Martin Reinecke committed
1
import nifty6
Martin Reinecke's avatar
Martin Reinecke committed
2
3

extensions = [
Philipp Arras's avatar
Philipp Arras committed
4
5
6
    'sphinx.ext.napoleon',  # Support for NumPy and Google style docstrings
    'sphinx.ext.imgmath',  # Render math as images
    'sphinx.ext.viewcode'  # Add links to highlighted source code
Martin Reinecke's avatar
Martin Reinecke committed
7
8
9
]
master_doc = 'index'

Philipp Arras's avatar
Philipp Arras committed
10
11
12
napoleon_google_docstring = False
napoleon_numpy_docstring = True
napoleon_use_ivar = True
13
14
15
napoleon_use_admonition_for_notes = True
napoleon_use_admonition_for_examples = True
napoleon_use_admonition_for_references = True
Philipp Arras's avatar
Philipp Arras committed
16
napoleon_include_special_with_doc = True
Philipp Arras's avatar
Philipp Arras committed
17

Martin Reinecke's avatar
5->6    
Martin Reinecke committed
18
project = u'NIFTy6'
19
copyright = u'2013-2019, Max-Planck-Society'
Philipp Arras's avatar
Philipp Arras committed
20
author = u'Martin Reinecke'
21

Martin Reinecke's avatar
5->6    
Martin Reinecke committed
22
release = nifty6.version.__version__
23
version = release[:-2]
Martin Reinecke's avatar
Martin Reinecke committed
24
25
26

language = None
exclude_patterns = []
Martin Reinecke's avatar
tweaks    
Martin Reinecke committed
27
add_module_names = False
Martin Reinecke's avatar
Martin Reinecke committed
28
29

html_theme = "sphinx_rtd_theme"
30
html_logo = 'nifty_logo_black.png'
31

32
exclude_patterns = [
Martin Reinecke's avatar
5->6    
Martin Reinecke committed
33
    'mod/modules.rst', 'mod/nifty6.git_version.rst', 'mod/nifty6.logger.rst'
34
]