adding __init__() to docs

etlundquist · Jun 15, 2020 · 70c9672 · 70c9672
1 parent 2de4835
commit 70c9672
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 0 deletions.
diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -50,6 +50,15 @@
  'sphinx_rtd_theme'
 ]
 
+# add autodoc default options
+autodoc_default_options = {
+ 'members': True,
+ 'member-order': 'bysource',
+ 'special-members': '__init__',
+ 'undoc-members': True,
+ 'exclude-members': '__weakref__'
+}
+
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ['_templates']
 

diff --git a/docs/source/rankfm.rst b/docs/source/rankfm.rst
@@ -3,5 +3,6 @@ RankFM
 
 .. autoclass:: rankfm.rankfm.RankFM
  :members:
+ :undoc-members:
  :inherited-members: