Merge pull request #183 from AFM-SPM/ns-rse/fix-mkdocs

ns-rse · web-flow · commit 62e950278fb0 · 2026-01-14T13:20:23.000Z
docs: Fix mkdocs DeprecationWarning
diff --git a/docs/api.md b/docs/api.md
diff --git a/docs/api/asd.md b/docs/api/asd.md
@@ -1,8 +1,3 @@
 # ASD Modules
 
 ::: AFMReader.asd
-    handler: python
-    options:
-        docstring_style: numpy
-        rendering:
-            show_signature_annotations: true
diff --git a/docs/api/gwy.md b/docs/api/gwy.md
@@ -1,8 +1,3 @@
 # GWY Modules
 
 ::: AFMReader.gwy
-    handler: python
-    options:
-        docstring_style: numpy
-        rendering:
-            show_signature_annotations: true
diff --git a/docs/api/ibw.md b/docs/api/ibw.md
@@ -1,8 +1,3 @@
 # IBW Modules
 
 ::: AFMReader.ibw
-    handler: python
-    options:
-        docstring_style: numpy
-        rendering:
-            show_signature_annotations: true
diff --git a/docs/api/index.md b/docs/api/index.md
@@ -0,0 +1,12 @@
+# API
+
+Details of the API can be found on the following pages.
+
+- [`asd.py`](asd.md)
+- [`gwy.py`](gwy.md)
+- [`ibw.py`](ibw.md)
+- [`io`](io.md)
+- [`jpk.py`](jpk.md)
+- [`logging`](logging.md)
+- [`spm.py`](spm.md)
+- [`topostats.py`](topostats.md)
diff --git a/docs/api/io.md b/docs/api/io.md
@@ -1,8 +1,3 @@
 # IO Modules
 
 ::: AFMReader.io
-    handler: python
-    options:
-        docstring_style: numpy
-        rendering:
-            show_signature_annotations: true
diff --git a/docs/api/jpk.md b/docs/api/jpk.md
@@ -1,8 +1,3 @@
 # JPK Modules
 
 ::: AFMReader.jpk
-    handler: python
-    options:
-        docstring_style: numpy
-        rendering:
-            show_signature_annotations: true
diff --git a/docs/api/logging.md b/docs/api/logging.md
@@ -1,8 +1,3 @@
 # Logging Modules
 
 ::: AFMReader.logging
-    handler: python
-    options:
-        docstring_style: numpy
-        rendering:
-            show_signature_annotations: true
diff --git a/docs/api/spm.md b/docs/api/spm.md
@@ -1,8 +1,3 @@
 # SPM Modules
 
 ::: AFMReader.spm
-    handler: python
-    options:
-        docstring_style: numpy
-        rendering:
-            show_signature_annotations: true
diff --git a/docs/api/topostats.md b/docs/api/topostats.md
@@ -1,8 +1,3 @@
 # TopoStats Modules
 
 ::: AFMReader.topostats
-    handler: python
-    options:
-        docstring_style: numpy
-        rendering:
-            show_signature_annotations: true
diff --git a/docs/index.md b/docs/index.md
@@ -11,7 +11,7 @@ Lab](https://pyne-lab.uk/bio/) based at the [University of Sheffield](https://sh
 - [Contributing](contributing.md)
 - [Workflow](workflow.md)
 - [Links](links.md)
-- [API](api.md)
+- [API](api/index.md)
 
 ## Citing
 
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -28,7 +28,12 @@ extra:
 plugins:
   - mermaid2:
   - search
-  - mkdocstrings
+  - mkdocstrings:
+      handlers:
+        python:
+          options:
+            docstring_style: numpy
+            show_signature_annotations: true
   - mike:
       version: true
 
@@ -44,3 +49,7 @@ markdown_extensions:
         - name: mermaid
           class: mermaid
           format: !!python/name:mermaid2.fence_mermaid
+
+watch:
+  - docs/
+  - AFMReader/
