conf.py 1.14 KB
Newer Older
Martin Reinecke's avatar
Martin Reinecke committed
1
import nifty7
Martin Reinecke's avatar
Martin Reinecke committed
2

Philipp Arras's avatar
Philipp Arras committed
3
4
needs_sphinx = '3.2.0'

Martin Reinecke's avatar
Martin Reinecke committed
5
extensions = [
Philipp Arras's avatar
Philipp Arras committed
6
7
8
    '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
9
10
11
]
master_doc = 'index'

Philipp Arras's avatar
Philipp Arras committed
12
13
14
napoleon_google_docstring = False
napoleon_numpy_docstring = True
napoleon_use_ivar = True
15
16
17
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
18
napoleon_include_special_with_doc = True
Philipp Arras's avatar
Philipp Arras committed
19

Martin Reinecke's avatar
Martin Reinecke committed
20
project = u'NIFTy7'
Philipp Arras's avatar
Philipp Arras committed
21
copyright = u'2013-2021, Max-Planck-Society'
Philipp Arras's avatar
Philipp Arras committed
22
author = u'Martin Reinecke'
23

Martin Reinecke's avatar
Martin Reinecke committed
24
release = nifty7.version.__version__
25
version = release[:-2]
Martin Reinecke's avatar
Martin Reinecke committed
26
27
28

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

Philipp Arras's avatar
Philipp Arras committed
31
html_theme = "pydata_sphinx_theme"
32
html_logo = 'nifty_logo_black.png'
Philipp Arras's avatar
Philipp Arras committed
33
34
35
36
37
38
39
40
41
42
html_theme_options = {
    "icon_links": [
        {
            "name": "PyPI",
            "url": "https://pypi.org/project/nifty7",
            "icon": "fas fa-box",
        }
    ],
    "gitlab_url": "https://gitlab.mpcdf.mpg.de/ift/nifty",
}
43

44
exclude_patterns = [
Martin Reinecke's avatar
Martin Reinecke committed
45
    'mod/modules.rst', 'mod/nifty7.git_version.rst', 'mod/nifty7.logger.rst'
46
]