⚙️ include private classes in code docs

sharkutilities · Aug 18, 2024 · 01e31b0 · 01e31b0
1 parent 554a6b8
commit 01e31b0
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 1 deletion.
diff --git a/docs/conf.py b/docs/conf.py
@@ -32,6 +32,13 @@
 templates_path = ['_templates']
 exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
 
+# -- Autodoc configurations --------------------------------------------------
+# https://stackoverflow.com/a/44638788/6623589 reduces code writing at automodule config
+autodoc_default_options = {
+    "members": True,
+    "undoc-members": False,
+    "private-members": True
+}
 
 
 # -- Options for HTML output -------------------------------------------------

diff --git a/docs/normalize.md b/docs/normalize.md
@@ -4,7 +4,6 @@
 
 ```{eval-rst}
 .. automodule:: nlpurify.normalize
-  :members:
 ```
 
 </div>