Merge pull request #454 from carpedm20/google-style-docstrings

Google docstring style
This commit is contained in:
Mads Marquart
2019-07-24 21:56:33 +02:00
committed by GitHub
2 changed files with 917 additions and 672 deletions

View File

@@ -41,6 +41,7 @@ extensions = [
"sphinx.ext.intersphinx",
"sphinx.ext.todo",
"sphinx.ext.viewcode",
"sphinx.ext.napoleon",
]
# Add any paths that contain templates here, relative to this directory.
@@ -182,3 +183,13 @@ intersphinx_mapping = {"https://docs.python.org/": None}
todo_include_todos = True
todo_link_only = True
# -- Options for napoleon extension ----------------------------------------------
# Use Google style docstrings
napoleon_google_docstring = True
napoleon_numpy_docstring = False
# napoleon_use_admonition_for_examples = False
# napoleon_use_admonition_for_notes = False
# napoleon_use_admonition_for_references = False

File diff suppressed because it is too large Load Diff