Skip to content

doc_stack/google_style_docstrings #1858

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

Merged
merged 2 commits into from
Aug 23, 2023
Merged

doc_stack/google_style_docstrings #1858

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c2b3898
initial commit for doc_stack/google_style_docstrings
cspotcode Aug 6, 2023
a74a993
Enable napoleon
cspotcode Aug 6, 2023
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
4 changes: 4 additions & 0 deletions doc/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,6 +54,7 @@
# ones.
extensions = [
'sphinx.ext.autodoc',
'sphinx.ext.napoleon',
'sphinx.ext.doctest',
'sphinx.ext.intersphinx',
'sphinx.ext.todo',
Expand Down Expand Up @@ -117,6 +118,9 @@
# If true, `todo` and `todoList` produce output, else they produce nothing.
todo_include_todos = True

napoleon_numpy_docstring = False
napoleon_google_docstring = True

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

# The theme to use for HTML and HTML Help pages. See the documentation for
Expand Down