Skip to content

Commit

Permalink
refactor: add Napoleon for API docs (#10)
Browse files Browse the repository at this point in the history
  • Loading branch information
elliesch authored Mar 22, 2024
1 parent 6793549 commit b120e97
Showing 1 changed file with 25 additions and 2 deletions.
27 changes: 25 additions & 2 deletions docs/_config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,31 @@ bibtex_bibfiles:

# Configure the citation style
sphinx:
config:
bibtex_reference_style: author_year
extra_extensions:
- 'sphinx.ext.autodoc'
- 'sphinx.ext.autosummary'
- 'sphinx.ext.napoleon'
- 'sphinx.ext.viewcode'
- 'custom-directives'
- 'sphinx_sitemap'
- 'myst_nb'

config:
bibtex_reference_style: author_year
add_module_names: False
autosummary_generate: True
autodoc_typehints: description
napoleon_google_docstring: False
napoleon_numpy_docstring: True
napoleon_include_init_with_doc: False
napoleon_include_private_with_doc: False
napoleon_include_special_with_doc: False
napoleon_use_admonition_for_examples: False
napoleon_use_admonition_for_notes: True
napoleon_use_admonition_for_references: True
napoleon_use_ivar: False
napoleon_use_param: True
napoleon_use_rtype: True
suppress_warnings:
- 'etoc.toctree'
- 'etoc.tableofcontents'

0 comments on commit b120e97

Please sign in to comment.