added autodoc

FAIRChemistry · Feb 6, 2024 · 2a5990f · 2a5990f
1 parent 8a7850d
commit 2a5990f
Show file tree

Hide file tree

Showing 3 changed files with 9 additions and 2 deletions.
diff --git a/.github/workflows/mkdocs.yml b/.github/workflows/mkdocs.yml
@@ -17,6 +17,7 @@ jobs:
       - uses: actions/setup-python@v4
         with:
           python-version: 3.x
+      - run: pip install -e .
       - uses: actions/cache@v2
         with:
           path: .cache

diff --git a/docs/examples.md b/docs/examples.md
@@ -1,3 +1,6 @@
 # Examples
 
-This is an example of how to use the Spectromax...
+This is an example of how to use the Spectromax...
+
+::: MTPHandler.core.plate.Plate
+    handler: python
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -51,4 +51,7 @@ markdown_extensions:
       emoji_generator: !!python/name:material.extensions.emoji.to_svg
   - def_list
   - pymdownx.tasklist:
-      custom_checkbox: true
+      custom_checkbox: true
+  - admonition
+  - codehilite
+  - mkautodoc