generate members details

vecto-ai · Dec 6, 2018 · 7ab57a5 · 7ab57a5
1 parent 5c820f0
commit 7ab57a5
Show file tree

Hide file tree

Showing 2 changed files with 15 additions and 1 deletion.
diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -53,7 +53,20 @@
     'sphinx.ext.viewcode',
 ]
 
-autosummary_generate = True 
+autosummary_generate = True  # Make _autosummary files and include them
+autoclass_content = "both"
+autodoc_default_flags = [
+    # Make sure that any autodoc declarations show the right members
+    "members",
+    "inherited-members",
+    "private-members",
+    "show-inheritance",
+]
+napoleon_numpy_docstring = False  # Force consistency, leave only Google
+napoleon_use_rtype = False  # More legible
+
+
+numpydoc_show_class_members = False
 
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ['_templates']

diff --git a/vecto/__init__.py b/vecto/__init__.py
@@ -7,6 +7,7 @@
     :toctree: _autosummary
 
     embeddings
+    corpus
     vocabulary
     benchmarks
 """