🐛 fix: add missing plugin to mkdocs.yml

microsoft · Aug 29, 2024 · 99582e5 · 99582e5
1 parent c45fd3e
commit 99582e5
Show file tree

Hide file tree

Showing 2 changed files with 20 additions and 1 deletion.
diff --git a/docs/reference.md.jinja b/docs/reference.md.jinja
@@ -1,3 +1,3 @@
-# :books: API reference
+# :books: reference
 
 ::: {{ module_name }}
diff --git a/template/{% if documentation %}mkdocs.yml{% endif %}.jinja b/template/{% if documentation %}mkdocs.yml{% endif %}.jinja
@@ -50,6 +50,25 @@ extra_css:
 #  - js/tex-mml-chtml.js
 plugins:
   - search
+  - mkdocstrings:
+      default_handler: python
+      handlers:
+        python:
+          paths: [src]
+          options:
+            show_inheritance_diagram: true
+            show_if_no_docstring: true
+            show_symbol_type_toc: true
+            show_symbol_type_heading: true
+            show_signature_annotations: true
+            show_submodules: true
+            show_source: true
+            group_by_category: false
+            show_category_heading: true
+            docstring_options:
+              ignore_init_summary: false
+              merge_init_into_class: true
+              separate_signature: true
   - awesome-pages
   - mkdocs-video:
       is_video: true