docs: add api reference pages for all modules (#344)

Fixes #343
afuetterer · Apr 25, 2024 · 8578031 · 8578031
1 parent 1f7a9ee
commit 8578031
Show file tree

Hide file tree

Showing 7 changed files with 19 additions and 36 deletions.
diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml
@@ -8,17 +8,21 @@ repo_name: afuetterer/oaipmh-scythe
 repo_url: https://github.com/afuetterer/oaipmh-scythe
 docs_dir: src
 edit_uri: edit/main/docs/
+watch:
+- ../src
 
 nav:
 - Home: index.md
 - Tutorial: tutorial.md
 - OAI-PMH Primer: oaipmh.md
 - Harvesting other Metadata Formats than OAI-DC: customizing.md
 - API:
-  - The Scythe Client: api/client.md
-  - Working with OAI Responses: api/response.md
-  - Iterating over OAI Items: api/iterator.md
-  - Classes for OAI Items: api/models.md
+  - Client: api/client.md
+  - Iterator: api/iterator.md
+  - Models: api/models.md
+  - Response: api/response.md
+  - Utils: api/utils.md
+  - Exceptions: api/exceptions.md
 - Meta:
   - Contributor Guide: contributing.md
   - Changelog: changelog.md
@@ -51,6 +55,11 @@ plugins:
     default_handler: python
     handlers:
       python:
+        paths:
+        - ../src
+        options:
+          show_root_heading: false
+          show_root_toc_entry: false
         import:
         - https://docs.python.org/3/objects.inv
 

diff --git a/docs/src/api/client.md b/docs/src/api/client.md
@@ -1,3 +1 @@
-::: oaipmh_scythe.client.Scythe
-    options:
-        show_root_heading: true
+::: oaipmh_scythe.client
diff --git a/docs/src/api/exceptions.md b/docs/src/api/exceptions.md
@@ -0,0 +1 @@
+::: oaipmh_scythe.exceptions
diff --git a/docs/src/api/iterator.md b/docs/src/api/iterator.md
@@ -1,7 +1 @@
-::: oaipmh_scythe.iterator.OAIItemIterator
-    options:
-        show_root_heading: true
-
-::: oaipmh_scythe.iterator.OAIResponseIterator
-    options:
-        show_root_heading: true
+::: oaipmh_scythe.iterator
diff --git a/docs/src/api/models.md b/docs/src/api/models.md
@@ -1,19 +1 @@
-::: oaipmh_scythe.models.Identify
-    options:
-        show_root_heading: true
-
-::: oaipmh_scythe.models.Record
-    options:
-        show_root_heading: true
-
-::: oaipmh_scythe.models.Header
-    options:
-        show_root_heading: true
-
-::: oaipmh_scythe.models.Set
-    options:
-        show_root_heading: true
-
-::: oaipmh_scythe.models.MetadataFormat
-    options:
-        show_root_heading: true
+::: oaipmh_scythe.models
diff --git a/docs/src/api/response.md b/docs/src/api/response.md
@@ -1,3 +1 @@
-::: oaipmh_scythe.response.OAIResponse
-    options:
-        show_root_heading: true
+::: oaipmh_scythe.response
diff --git a/docs/src/api/utils.md b/docs/src/api/utils.md
@@ -0,0 +1 @@
+::: oaipmh_scythe.utils