conf.py 4.62 KB
Newer Older
Martin Reinecke's avatar
Martin Reinecke committed
1
2
# -*- coding: utf-8 -*-
#
Martin Reinecke's avatar
Martin Reinecke committed
3
# NIFTy documentation build configuration file, created by
Martin Reinecke's avatar
Martin Reinecke committed
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
# sphinx-quickstart on Tue May 16 10:22:50 2017.
#
# This file is execfile()d with the current directory set to its
# containing dir.
#
# Note that not all possible configuration values are present in this
# autogenerated file.
#
# All configuration values have a default; values that are commented out
# serve to show the default.

import sys
import os
import sphinx_rtd_theme



# If extensions (or modules to document with autodoc) are in another directory,
# add these directories to sys.path here. If the directory is relative to the
# documentation root, use os.path.abspath to make it absolute, like shown here.
Martin Reinecke's avatar
tweaks    
Martin Reinecke committed
24
#sys.path.insert(0, os.path.abspath('.'))
Martin Reinecke's avatar
Martin Reinecke committed
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

napoleon_google_docstring = False
napoleon_numpy_docstring = True

napoleon_use_ivar = True
napoleon_use_param = False
napoleon_use_keyword = False


autodoc_member_order='groupwise'

#autosummary_generate = True

numpydoc_show_inherited_class_members=False
numpydoc_class_members_toctree=False


# -- General configuration ------------------------------------------------

# If your documentation needs a minimal Sphinx version, state it here.
#needs_sphinx = '1.0'

# Add any Sphinx extension module names here, as strings. They can be
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones.
extensions = [
    'sphinx.ext.autodoc',
    'numpydoc',
    'sphinx.ext.autosummary',
    'sphinx.ext.napoleon',
Martin Reinecke's avatar
Martin Reinecke committed
55
    'sphinx.ext.imgmath',
Martin Reinecke's avatar
Martin Reinecke committed
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
    'sphinx.ext.viewcode'
]

# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']

# The suffix(es) of source filenames.
# You can specify multiple suffix as a list of string:
# source_suffix = ['.rst', '.md']
source_suffix = '.rst'

# The encoding of source files.
#source_encoding = 'utf-8-sig'

# The master toctree document.
master_doc = 'index'

# General information about the project.
Philipp Arras's avatar
Philipp Arras committed
74
project = u'NIFTy5'
75
copyright = u'2013-2019, Max-Planck-Society'
Martin Reinecke's avatar
Martin Reinecke committed
76
77
78
79
80
81
82
author = u'Theo Steininger / Martin Reinecke'

# The version info for the project you're documenting, acts as replacement for
# |version| and |release|, also used in various other places throughout the
# built documents.
#
# The short X.Y version.
Martin Reinecke's avatar
Martin Reinecke committed
83
version = u'5.0'
Martin Reinecke's avatar
Martin Reinecke committed
84
# The full version, including alpha/beta/rc tags.
Martin Reinecke's avatar
Martin Reinecke committed
85
release = u'5.0.0'
Martin Reinecke's avatar
Martin Reinecke committed
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102

# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
#
# This is also used if you do content translation via gettext catalogs.
# Usually you set "language" from the command line for these cases.
language = None

# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
exclude_patterns = []

# If true, '()' will be appended to :func: etc. cross-reference text.
#add_function_parentheses = True

# If true, the current module name will be prepended to all description
# unit titles (such as .. function::).
Martin Reinecke's avatar
tweaks    
Martin Reinecke committed
103
add_module_names = False
Martin Reinecke's avatar
Martin Reinecke committed
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134

# If true, sectionauthor and moduleauthor directives will be shown in the
# output. They are ignored by default.
#show_authors = False

# The name of the Pygments (syntax highlighting) style to use.
pygments_style = 'sphinx'

# If true, `todo` and `todoList` produce output, else they produce nothing.
todo_include_todos = True


# -- Options for HTML output ----------------------------------------------

# The theme to use for HTML and HTML Help pages.  See the documentation for
# a list of builtin themes.
html_theme = "sphinx_rtd_theme"

# Theme options are theme-specific and customize the look and feel of a theme
# further.  For a list of options available for each theme, see the
# documentation.
html_theme_options = {
     'collapse_navigation': False,
     'display_version': False,
     #'navigation_depth': 3,
}

html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]

# The name of an image file (relative to this directory) to place at the top
# of the sidebar.
135
html_logo = 'nifty_logo_black.png'
Martin Reinecke's avatar
Martin Reinecke committed
136
137
138
139

# Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files,
# so a file named "default.css" will overwrite the builtin "default.css".
Martin Reinecke's avatar
Martin Reinecke committed
140
html_static_path = []
Martin Reinecke's avatar
Martin Reinecke committed
141
142
143
144
145
146
147
148
149

# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
# using the given strftime format.
html_last_updated_fmt = '%b %d, %Y'

# If false, no module index is generated.
html_domain_indices = False

# If false, no index is generated.
150
html_use_index = False
Martin Reinecke's avatar
Martin Reinecke committed
151
152

# If true, links to the reST sources are added to the pages.
153
html_show_sourcelink = False
Martin Reinecke's avatar
Martin Reinecke committed
154
155

# Output file base name for HTML help builder.
Martin Reinecke's avatar
Martin Reinecke committed
156
htmlhelp_basename = 'NIFTydoc'