docs: render only public API (#19)

Signed-off-by: Jan Kowalleck <jan.kowalleck@gmail.com>
madpah · Sep 27, 2023 · fcc5d8e · fcc5d8e
1 parent 296ef19
commit fcc5d8e
Showing 1 changed file with 3 additions and 1 deletion.
diff --git a/docs/conf.py b/docs/conf.py
@@ -34,7 +34,7 @@
 # ones.
 extensions = [
     "sphinx.ext.autodoc",
-    "sphinx.ext.viewcode",
+    # "sphinx.ext.viewcode",
     "autoapi.extension",
     "sphinx_rtd_theme",
     "m2r2"
@@ -43,6 +43,8 @@
 # Document Python Code
 autoapi_type = 'python'
 autoapi_dirs = ['../serializable']
+# see https://sphinx-autoapi.readthedocs.io/en/latest/reference/config.html#confval-autoapi_options
+autoapi_options = ['show-module-summary', 'members', 'undoc-members', 'inherited-members', 'show-inheritance']
 
 source_suffix = ['.rst', '.md']