Merge pull request #85 from deel-ai/doc/improve_mkdocs

Improve mkdocstrings configuration
deel-ai · Nov 10, 2023 · 8f4635b · 8f4635b
2 parents d8da411 + 3454bd6
commit 8f4635b
Show file tree

Hide file tree

Showing 3 changed files with 10 additions and 4 deletions.
diff --git a/docs/api/layers.md b/docs/api/layers.md
@@ -1,5 +1,4 @@
 ::: deel.lip.layers
     options:
         show_root_toc_entry: True
-        inherited_members: True
         show_submodules: True
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -41,7 +41,13 @@ theme:
 
 plugins:
   - search
-  - mkdocstrings
+  - mkdocstrings:
+      handlers:
+        python:
+          options:
+            merge_init_into_class: true
+            docstring_section_style: spacy
+            separate_signature: true
   - mknotebooks
 
 markdown_extensions:
@@ -62,8 +68,8 @@ markdown_extensions:
       custom_checkbox: true
       clickable_checkbox: true
   - pymdownx.emoji:
-      emoji_index: !!python/name:materialx.emoji.twemoji
-      emoji_generator: !!python/name:materialx.emoji.to_svg
+      emoji_index: !!python/name:material.extensions.emoji.twemoji
+      emoji_generator: !!python/name:material.extensions.emoji.to_svg
 
 extra_css:
   - css/custom.css

diff --git a/setup.py b/setup.py
@@ -29,6 +29,7 @@
     "mkdocstrings-python",
     "mknotebooks",
     "ipython",  # required for Pygments
+    "black",  # required for mkdocs signature rendering
 ]
 
 setuptools.setup(