add metrics to docs

afids · Sep 18, 2023 · 97f6474 · 97f6474
1 parent b1c3df4
commit 97f6474
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 1 deletion.
diff --git a/docs/api/metrics.md b/docs/api/metrics.md
@@ -0,0 +1,6 @@
+## afids_utils.metrics
+
+```{eval-rst}
+    .. automodule:: afids_utils.metrics
+        :members:
+```
diff --git a/docs/index.md b/docs/index.md
@@ -1,4 +1,5 @@
 ```{include} ../README.md
+
 ```
 
 ```{toctree}
@@ -8,13 +9,15 @@
 :maxdepth: 1
 
 api/afids
+api/metrics
 api/transform
 ```
+
 ```{toctree}
 :caption: Exceptions
 :name: afids_exceptions
 :hidden:
 :maxdepth: 1
 
 exceptions/exceptions
-```
+```