diff --git a/docs/source/conf.py b/docs/source/conf.py index 9219f72c3..64fbf4846 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -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 = []