Skip to content

Add sphinx.ext.napoleon for NumPy-style docstrings #498

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
timosachsenberg wants to merge 1 commit into from
+17 −0
Closed

Add sphinx.ext.napoleon for NumPy-style docstrings #498

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 17 additions & 0 deletions docs/source/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,10 +43,27 @@
'glossary_warnings',
'sphinx_copybutton', 'sphinx.ext.autodoc',
'sphinx.ext.autosummary', 'sphinx.ext.mathjax',
'sphinx.ext.napoleon', # Support NumPy and Google style docstrings
'sphinx_remove_toctrees',
'chemrole',
]

# Napoleon settings for NumPy-style docstrings
napoleon_google_docstring = True
napoleon_numpy_docstring = True
napoleon_include_init_with_doc = False
napoleon_include_private_with_doc = False
napoleon_include_special_with_doc = True
napoleon_use_admonition_for_examples = False
napoleon_use_admonition_for_notes = False
napoleon_use_admonition_for_references = False
napoleon_use_ivar = False
napoleon_use_param = True
napoleon_use_rtype = True
napoleon_preprocess_types = False
napoleon_type_aliases = None
napoleon_attr_annotations = True

## warn about invalid references (e.g. invalid class names)
nitpicky = True
nitpick_ignore = []
Expand Down
Loading