Skip to content
Snippets Groups Projects
Commit 2f5ab8f3 authored by Philipp Arras's avatar Philipp Arras
Browse files

Switch to napoleon only

parent 972e8bc7
No related branches found
No related tags found
No related merge requests found
......@@ -7,7 +7,7 @@ RUN apt-get update && apt-get install -y \
libfftw3-dev \
python3 python3-pip python3-dev python3-future python3-scipy cython3 \
# Documentation build dependencies
python3-sphinx python3-sphinx-rtd-theme python3-numpydoc \
python3-sphinx python3-sphinx-rtd-theme \
# Testing dependencies
python3-coverage python3-pytest python3-pytest-cov \
# Optional NIFTy dependencies
......
import nifty5
import sphinx_rtd_theme
napoleon_google_docstring = False
napoleon_numpy_docstring = True
napoleon_use_ivar = True
napoleon_use_param = False
napoleon_use_keyword = False
autodoc_member_order = 'groupwise'
numpydoc_show_inherited_class_members = False
numpydoc_class_members_toctree = False
extensions = [
'sphinx.ext.autodoc', 'numpydoc', 'sphinx.ext.autosummary',
'sphinx.ext.napoleon', 'sphinx.ext.imgmath', 'sphinx.ext.viewcode'
'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
]
templates_path = ['_templates']
source_suffix = '.rst'
master_doc = 'index'
napoleon_google_docstring = False
napoleon_numpy_docstring = True
napoleon_use_ivar = True
project = u'NIFTy5'
copyright = u'2013-2019, Max-Planck-Society'
author = u'Martin Reinecke'
......@@ -29,19 +21,6 @@ version = release[:-2]
language = None
exclude_patterns = []
add_module_names = False
pygments_style = 'sphinx'
todo_include_todos = True
html_theme = "sphinx_rtd_theme"
html_theme_options = {
'collapse_navigation': False,
'display_version': False,
}
html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
html_logo = 'nifty_logo_black.png'
html_static_path = []
html_last_updated_fmt = '%b %d, %Y'
html_domain_indices = False
html_use_index = False
html_show_sourcelink = False
htmlhelp_basename = 'NIFTydoc'
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment