From b120e9759661c068c1da8d439602e55c6cb91991 Mon Sep 17 00:00:00 2001 From: "Ellie S. Abrahams" Date: Fri, 22 Mar 2024 13:57:07 -0700 Subject: [PATCH] refactor: add Napoleon for API docs (#10) --- docs/_config.yml | 27 +++++++++++++++++++++++++-- 1 file changed, 25 insertions(+), 2 deletions(-) diff --git a/docs/_config.yml b/docs/_config.yml index 8ec9af7..49efd0b 100644 --- a/docs/_config.yml +++ b/docs/_config.yml @@ -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'