Enable sphinx-like behavior through mkdocstrings-python extension

Quantco · Nov 5, 2024 · e02c269 · e02c269
1 parent 8daf954
commit e02c269
Show file tree

Hide file tree

Showing 3 changed files with 202 additions and 95 deletions.
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -40,7 +40,7 @@ plugins:
   - search
   - mkdocs-jupyter:
       ignore_h1_titles: False # Heading H1 -> Site title
-      execute: false
+      execute: false # TODO: Discuss whether this should be turned back on later
       allow_errors: false
       show_input: True
       include_source: True
@@ -54,13 +54,17 @@ plugins:
         python:
           paths: [metalearners]
           options:
+            extensions:
+              - griffe_inherited_docstrings:
+                  merge: True
             unwrap_annotated: true
             show_symbol_type_heading: true
             docstring_style: numpy
             docstring_section_style: spacy
             separate_signature: true
             merge_init_into_class: true
             show_submodules: true # show *all* code docu
+            inherited_members: true
 
 nav:
   # Demonstrate notebook inclusion