Change from numpydoc to napoleon

kboone · Apr 23, 2019 · 60ae640 · 60ae640
1 parent 391d7ab
commit 60ae640
Show file tree

Hide file tree

Showing 3 changed files with 16 additions and 5 deletions.
diff --git a/docs/conf.py b/docs/conf.py
@@ -31,13 +31,23 @@
     'sphinx.ext.autodoc',
     'sphinx.ext.autosummary',
     'sphinx.ext.mathjax',
-    'numpydoc',
+    'sphinx.ext.napoleon',
 ]
 
-numpydoc_show_class_members = False
 autosummary_generate = ["reference.rst"]
-autoclass_content = "class"
-autodoc_default_flags = ["members", "no-special-members"]
+
+# Napoleon settings
+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 = 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
 
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ['_templates']

diff --git a/docs/reference.rst b/docs/reference.rst
@@ -2,3 +2,5 @@ Reference / API
 ===============
 
 .. automodule:: avocado
+   :members:
+   :no-undoc-members:
diff --git a/docs/requirements.txt b/docs/requirements.txt