docs: add worms API module documentation

fathomnet · Feb 6, 2024 · 11c0112 · 11c0112
1 parent 3212b13
commit 11c0112
Showing 1 changed file with 13 additions and 0 deletions.
diff --git a/docs/source/api.rst b/docs/source/api.rst
@@ -264,6 +264,19 @@ Admin only
 
 ----
 
+WoRMS
+-----
+
+.. module:: fathomnet.api.worms
+
+The ``fathomnet.api.worms`` module supports World Register of Marine Species (WoRMS) lookup operations via the `fast WoRMS name service <https://github.com/fathomnet/worms-server>`_.
+
+.. automodule:: fathomnet.api.worms
+    :members:
+    :noindex:
+
+----
+
 X-API-Key
 ---------