DOC include inherited members in API reference (#172)

* DOC include inherited members in API reference via griffe / mkdocstring python * DOC minor fixes
lorentzenchr · Aug 12, 2024 · fd562be · fd562be
1 parent 8d8da1c
commit fd562be
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 1 deletion.
diff --git a/docs/examples/regression_on_workers_compensation.ipynb b/docs/examples/regression_on_workers_compensation.ipynb
@@ -785,7 +785,7 @@
    "id": "631c120d-c991-4c51-9a49-0282c21afbf4",
    "metadata": {},
    "source": [
-    "## 3.1. Reliability Diagrams\n",
+    "### 3.1. Reliability Diagrams\n",
     "A reliability diagram plots an estimation of $E(Y|m(X))$ versus $m(X)$ and therefore assesses auto-calibration.\n",
     "Good auto-calibration is seen by closeness to the diagonal depicted as dotted line.\n",
     "\n",

diff --git a/mkdocs.yml b/mkdocs.yml
@@ -74,6 +74,7 @@ plugins:
             filters:
               - "!^_[^_]"  # this is the default
               - "!^test"
+            inherited_members: true
             show_submodules: false  # this is the default
             # Headings
             show_root_heading: true
@@ -99,6 +100,7 @@ markdown_extensions:
   - md_in_html
   - toc:
       permalink: true
+      toc_depth: 3  # default = 3
 
   # Python Markdown Extensions
   - pymdownx.arithmatex: