Fix #420, autodoc even undocumented (docstring-less) method signatures

kevin1024 · Dec 16, 2019 · fe94fed · fe94fed
1 parent 7e4cff1
commit fe94fed
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 10 deletions.
diff --git a/docs/conf.py b/docs/conf.py
@@ -35,6 +35,10 @@ def find_version(*file_paths):
     raise RuntimeError("Unable to find version string.")
 
 
+autodoc_default_options = {
+    "members": None,
+    "undoc-members": None,
+}
 # If extensions (or modules to document with autodoc) are in another directory,
 # add these directories to sys.path here. If the directory is relative to the
 # documentation root, use os.path.abspath to make it absolute, like shown here.
@@ -286,15 +290,7 @@ def find_version(*file_paths):
 # (source start file, target name, title, author,
 #  dir menu entry, description, category)
 texinfo_documents = [
-    (
-        master_doc,
-        "vcrpy",
-        "vcrpy Documentation",
-        author,
-        "vcrpy",
-        "One line description of project.",
-        "Miscellaneous",
-    ),
+    (master_doc, "vcrpy", "vcrpy Documentation", author, "vcrpy", "One line description of project.", "Miscellaneous",),
 ]
 
 # Documents to append as an appendix to all manuals.

diff --git a/docs/index.rst b/docs/index.rst
@@ -4,7 +4,7 @@ Contents
 ========
 
 .. toctree::
-   :maxdepth: 2
+   :maxdepth: 3
 
    installation
    usage