switch to mkdocstring

vincentsarago · vincentsarago · commit 0cc6630e877c · 2025-04-04T11:20:55.000+02:00
diff --git a/.github/workflows/deploy_mkdocs.yml b/.github/workflows/deploy_mkdocs.yml
@@ -33,13 +33,5 @@ jobs:
             stac_fastapi/api[docs] \
             stac_fastapi/extensions[docs] \
 
-      - name: update API docs
-        run: |
-          pdocs as_markdown \
-            --output_dir docs/src/api/ \
-            --exclude_source \
-            --overwrite \
-            stac_fastapi
-
       - name: Deploy docs
         run: mkdocs gh-deploy --force -f docs/mkdocs.yml
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -36,13 +36,6 @@ To manually deploy docs (note you should never need to do this because GitHub
 Actions deploys automatically for new commits.):
 
 ```bash
-Create API documentations
-$ pdocs as_markdown \
-  --output_dir docs/src/api/ \
-  --exclude_source \
-  --overwrite \
-  stac_fastapi
-
 # deploy
 $ mkdocs gh-deploy -f docs/mkdocs.yml
 ```
diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml
@@ -30,24 +30,39 @@ nav:
           - models: api/stac_fastapi/api/models.md
           - openapi: api/stac_fastapi/api/openapi.md
           - routes: api/stac_fastapi/api/routes.md
-          - version: api/stac_fastapi/api/version.md
       - stac_fastapi.extensions:
           - module: api/stac_fastapi/extensions/index.md
           - core:
               - module: api/stac_fastapi/extensions/core/index.md
-              - context: api/stac_fastapi/extensions/core/context.md
-              - free_text:
-                - module: api/stac_fastapi/extensions/core/free_text/index.md
-                - free_text: api/stac_fastapi/extensions/core/free_text/free_text.md
-                - request: api/stac_fastapi/extensions/core/free_text/request.md
-              - filter:
-                  - module: api/stac_fastapi/extensions/core/filter/index.md
-                  - filter: api/stac_fastapi/extensions/core/filter/filter.md
-                  - request: api/stac_fastapi/extensions/core/filter/request.md
+              - aggregation:
+                - module: api/stac_fastapi/extensions/core/aggregation/index.md
+                - aggregation: api/stac_fastapi/extensions/core/aggregation/aggregation.md
+                - client: api/stac_fastapi/extensions/core/aggregation/client.md
+                - request: api/stac_fastapi/extensions/core/aggregation/request.md
+                - types: api/stac_fastapi/extensions/core/aggregation/types.md
+              - collection_search:
+                - module: api/stac_fastapi/extensions/core/collection_search/index.md
+                - collection_search: api/stac_fastapi/extensions/core/collection_search/collection_search.md
+                - client: api/stac_fastapi/extensions/core/collection_search/client.md
+                - request: api/stac_fastapi/extensions/core/collection_search/request.md
               - fields:
                   - module: api/stac_fastapi/extensions/core/fields/index.md
                   - fields: api/stac_fastapi/extensions/core/fields/fields.md
                   - request: api/stac_fastapi/extensions/core/fields/request.md
+              - filter:
+                  - module: api/stac_fastapi/extensions/core/filter/index.md
+                  - filter: api/stac_fastapi/extensions/core/filter/filter.md
+                  - request: api/stac_fastapi/extensions/core/filter/request.md
+              - free_text:
+                - module: api/stac_fastapi/extensions/core/free_text/index.md
+                - free_text: api/stac_fastapi/extensions/core/free_text/free_text.md
+                - request: api/stac_fastapi/extensions/core/free_text/request.md
+              - pagination:
+                  - module: api/stac_fastapi/extensions/core/pagination/index.md
+                  - pagination: api/stac_fastapi/extensions/core/pagination/pagination.md
+                  - offset_pagination: api/stac_fastapi/extensions/core/pagination/offset_pagination.md
+                  - token_pagination: api/stac_fastapi/extensions/core/pagination/token_pagination.md
+                  - request: api/stac_fastapi/extensions/core/pagination/request.md
               - query:
                   - module: api/stac_fastapi/extensions/core/query/index.md
                   - query: api/stac_fastapi/extensions/core/query/query.md
@@ -57,14 +72,9 @@ nav:
                   - request: api/stac_fastapi/extensions/core/sort/request.md
                   - sort: api/stac_fastapi/extensions/core/sort/sort.md
               - transaction: api/stac_fastapi/extensions/core/transaction.md
-              - pagination:
-                  - module: api/stac_fastapi/extensions/core/pagination/index.md
-                  - pagination: api/stac_fastapi/extensions/core/pagination/pagination.md
-                  - token_pagination: api/stac_fastapi/extensions/core/pagination/token_pagination.md
-              - version: api/stac_fastapi/extensions/version.md
           - third_party:
+              - module: api/stac_fastapi/extensions/third_party/index.md
               - bulk_transactions: api/stac_fastapi/extensions/third_party/bulk_transactions.md
-              - index: api/stac_fastapi/extensions/third_party/index.md
       - stac_fastapi.types:
           - module: api/stac_fastapi/types/index.md
           - config: api/stac_fastapi/types/config.md
@@ -77,7 +87,6 @@ nav:
           - rfc3339: api/stac_fastapi/types/rfc3339.md
           - search: api/stac_fastapi/types/search.md
           - stac: api/stac_fastapi/types/stac.md
-          - version: api/stac_fastapi/types/version.md
   - Migration Guides:
     - v2.5 -> v3.0: migrations/v3.0.0.md
     - v3.0 -> v4.0: migrations/v4.0.0.md
@@ -87,6 +96,29 @@ nav:
 
 plugins:
   - search
+  - mkdocstrings:
+      enable_inventory: true
+      handlers:
+        python:
+          paths: [src]
+          options:
+            docstring_section_style: list
+            docstring_style: google
+            line_length: 100
+            separate_signature: true
+            show_root_heading: true
+            show_signature_annotations: true
+            show_source: false
+            show_symbol_type_toc: true
+            signature_crossrefs: true
+            extensions:
+              - griffe_inherited_docstrings
+          inventories:
+            - https://docs.python.org/3/objects.inv
+            - https://docs.pydantic.dev/latest/objects.inv
+            - https://fastapi.tiangolo.com/objects.inv
+            - https://www.starlette.io/objects.inv
+            - https://www.attrs.org/en/stable/objects.inv
 
 # Theme
 theme:
diff --git a/docs/src/api/stac_fastapi/api/app.md b/docs/src/api/stac_fastapi/api/app.md
@@ -0,0 +1,3 @@
+::: stac_fastapi.api.app
+    options:
+      show_source: true
diff --git a/docs/src/api/stac_fastapi/api/config.md b/docs/src/api/stac_fastapi/api/config.md
@@ -0,0 +1,3 @@
+::: stac_fastapi.api.config
+    options:
+      show_source: true
diff --git a/docs/src/api/stac_fastapi/api/errors.md b/docs/src/api/stac_fastapi/api/errors.md
@@ -0,0 +1,3 @@
+::: stac_fastapi.api.errors
+    options:
+      show_source: true
diff --git a/docs/src/api/stac_fastapi/api/index.md b/docs/src/api/stac_fastapi/api/index.md
@@ -0,0 +1,14 @@
+# Module stac_fastapi.api
+
+Api submodule.
+
+## Sub-modules
+
+* [stac_fastapi.api.app](app.md)
+* [stac_fastapi.api.config](config.md)
+* [stac_fastapi.api.errors](errors.md)
+* [stac_fastapi.api.middleware](middleware.md)
+* [stac_fastapi.api.models](models.md)
+* [stac_fastapi.api.openapi](openapi.md)
+* [stac_fastapi.api.routes](routes.md)
+
diff --git a/docs/src/api/stac_fastapi/api/middleware.md b/docs/src/api/stac_fastapi/api/middleware.md
@@ -0,0 +1,3 @@
+::: stac_fastapi.api.middleware
+    options:
+      show_source: true
diff --git a/docs/src/api/stac_fastapi/api/models.md b/docs/src/api/stac_fastapi/api/models.md
@@ -0,0 +1,3 @@
+::: stac_fastapi.api.models
+    options:
+      show_source: true
diff --git a/docs/src/api/stac_fastapi/api/openapi.md b/docs/src/api/stac_fastapi/api/openapi.md
@@ -0,0 +1,3 @@
+::: stac_fastapi.api.openapi
+    options:
+      show_source: true
diff --git a/docs/src/api/stac_fastapi/api/routes.md b/docs/src/api/stac_fastapi/api/routes.md
@@ -0,0 +1,3 @@
+::: stac_fastapi.api.routes
+    options:
+      show_source: true
diff --git a/docs/src/api/stac_fastapi/extensions/core/aggregation/aggregation.md b/docs/src/api/stac_fastapi/extensions/core/aggregation/aggregation.md
@@ -0,0 +1,3 @@
+::: stac_fastapi.extensions.core.aggregation.aggregation
+    options:
+      show_source: true
diff --git a/docs/src/api/stac_fastapi/extensions/core/aggregation/client.md b/docs/src/api/stac_fastapi/extensions/core/aggregation/client.md
@@ -0,0 +1,3 @@
+::: stac_fastapi.extensions.core.aggregation.client
+    options:
+      show_source: true
diff --git a/docs/src/api/stac_fastapi/extensions/core/aggregation/index.md b/docs/src/api/stac_fastapi/extensions/core/aggregation/index.md
@@ -0,0 +1,10 @@
+# Module stac_fastapi.extensions.core.aggregation
+
+Aggregation Extensions submodule.
+
+## Sub-modules
+
+* [stac_fastapi.extensions.core.aggregation.aggregation](aggregation.md)
+* [stac_fastapi.extensions.core.aggregation.client](client.md)
+* [stac_fastapi.extensions.core.aggregation.request](request.md)
+* [stac_fastapi.extensions.core.aggregation.types](types.md)
diff --git a/docs/src/api/stac_fastapi/extensions/core/aggregation/request.md b/docs/src/api/stac_fastapi/extensions/core/aggregation/request.md
@@ -0,0 +1,3 @@
+::: stac_fastapi.extensions.core.aggregation.request
+    options:
+      show_source: true
diff --git a/docs/src/api/stac_fastapi/extensions/core/aggregation/types.md b/docs/src/api/stac_fastapi/extensions/core/aggregation/types.md
@@ -0,0 +1,3 @@
+::: stac_fastapi.extensions.core.aggregation.types
+    options:
+      show_source: true
diff --git a/docs/src/api/stac_fastapi/extensions/core/collection_search/client.md b/docs/src/api/stac_fastapi/extensions/core/collection_search/client.md
@@ -0,0 +1,4 @@
+
+::: stac_fastapi.extensions.core.collection_search.client
+    options:
+      show_source: true
diff --git a/docs/src/api/stac_fastapi/extensions/core/collection_search/collection_search.md b/docs/src/api/stac_fastapi/extensions/core/collection_search/collection_search.md
@@ -0,0 +1,5 @@
+
+
+::: stac_fastapi.extensions.core.collection_search.collection_search
+    options:
+      show_source: true
diff --git a/docs/src/api/stac_fastapi/extensions/core/collection_search/index.md b/docs/src/api/stac_fastapi/extensions/core/collection_search/index.md
@@ -0,0 +1,9 @@
+# Module stac_fastapi.extensions.core.collection_search
+
+Collection-Search Extensions submodule.
+
+## Sub-modules
+
+* [stac_fastapi.extensions.core.collection_search.collection_search](collection_search.md)
+* [stac_fastapi.extensions.core.collection_search.client](client.md)
+* [stac_fastapi.extensions.core.collection_search.request](request.md)
diff --git a/docs/src/api/stac_fastapi/extensions/core/collection_search/request.md b/docs/src/api/stac_fastapi/extensions/core/collection_search/request.md
@@ -0,0 +1,6 @@
+
+
+
+::: stac_fastapi.extensions.core.collection_search.request
+    options:
+      show_source: true
diff --git a/docs/src/api/stac_fastapi/extensions/core/fields/fields.md b/docs/src/api/stac_fastapi/extensions/core/fields/fields.md
@@ -0,0 +1,5 @@
+
+
+::: stac_fastapi.extensions.core.fields.fields
+    options:
+      show_source: true
diff --git a/docs/src/api/stac_fastapi/extensions/core/fields/index.md b/docs/src/api/stac_fastapi/extensions/core/fields/index.md
@@ -0,0 +1,8 @@
+# Module stac_fastapi.extensions.core.fields
+
+Fields Extensions submodule.
+
+## Sub-modules
+
+* [stac_fastapi.extensions.core.fields.fields](fields.md)
+* [stac_fastapi.extensions.core.fields.request](request.md)
diff --git a/docs/src/api/stac_fastapi/extensions/core/fields/request.md b/docs/src/api/stac_fastapi/extensions/core/fields/request.md
@@ -0,0 +1,6 @@
+
+
+
+::: stac_fastapi.extensions.core.fields.request
+    options:
+      show_source: true
diff --git a/docs/src/api/stac_fastapi/extensions/core/filter/filter.md b/docs/src/api/stac_fastapi/extensions/core/filter/filter.md
@@ -0,0 +1,5 @@
+
+
+::: stac_fastapi.extensions.core.filter.filter
+    options:
+      show_source: true
diff --git a/docs/src/api/stac_fastapi/extensions/core/filter/index.md b/docs/src/api/stac_fastapi/extensions/core/filter/index.md
@@ -0,0 +1,8 @@
+# Module stac_fastapi.extensions.core.filter
+
+Filter Extensions submodule.
+
+## Sub-modules
+
+* [stac_fastapi.extensions.core.filter.filter](filter.md)
+* [stac_fastapi.extensions.core.filter.request](request.md)
diff --git a/docs/src/api/stac_fastapi/extensions/core/filter/request.md b/docs/src/api/stac_fastapi/extensions/core/filter/request.md
@@ -0,0 +1,6 @@
+
+
+
+::: stac_fastapi.extensions.core.filter.request
+    options:
+      show_source: true
diff --git a/docs/src/api/stac_fastapi/extensions/core/free_text/free_text.md b/docs/src/api/stac_fastapi/extensions/core/free_text/free_text.md
@@ -0,0 +1,5 @@
+
+
+::: stac_fastapi.extensions.core.free_text.free_text
+    options:
+      show_source: true
diff --git a/docs/src/api/stac_fastapi/extensions/core/free_text/index.md b/docs/src/api/stac_fastapi/extensions/core/free_text/index.md
@@ -0,0 +1,8 @@
+# Module stac_fastapi.extensions.core.free_text
+
+Free-Text Extensions submodule.
+
+## Sub-modules
+
+* [stac_fastapi.extensions.core.free_text.free_text](free_text.md)
+* [stac_fastapi.extensions.core.free_text.request](request.md)
diff --git a/docs/src/api/stac_fastapi/extensions/core/free_text/request.md b/docs/src/api/stac_fastapi/extensions/core/free_text/request.md
@@ -0,0 +1,6 @@
+
+
+
+::: stac_fastapi.extensions.core.free_text.request
+    options:
+      show_source: true
diff --git a/docs/src/api/stac_fastapi/extensions/core/index.md b/docs/src/api/stac_fastapi/extensions/core/index.md
@@ -0,0 +1,13 @@
+# Module stac_fastapi.extensions
+
+Extensions submodule.
+
+## Sub-modules
+
+* [stac_fastapi.extensions.core.fields](fields/index.md)
+* [stac_fastapi.extensions.core.filter](filter/index.md)
+* [stac_fastapi.extensions.core.free_text](free_text/index.md)
+* [stac_fastapi.extensions.core.pagination](pagination/index.md)
+* [stac_fastapi.extensions.core.query](query/index.md)
+* [stac_fastapi.extensions.core.sort](sort/index.md)
+* [stac_fastapi.extensions.core.transaction](transaction.md)
diff --git a/docs/src/api/stac_fastapi/extensions/core/pagination/index.md b/docs/src/api/stac_fastapi/extensions/core/pagination/index.md
@@ -0,0 +1,10 @@
+# Module stac_fastapi.extensions.core.pagination
+
+Pagination Extensions submodule.
+
+## Sub-modules
+
+* [stac_fastapi.extensions.core.pagination.pagination](pagination.md)
+* [stac_fastapi.extensions.core.pagination.offset_pagination](offset_pagination.md)
+* [stac_fastapi.extensions.core.pagination.token_pagination](token_pagination.md)
+* [stac_fastapi.extensions.core.pagination.request](request.md)
diff --git a/docs/src/api/stac_fastapi/extensions/core/pagination/offset_pagination.md b/docs/src/api/stac_fastapi/extensions/core/pagination/offset_pagination.md
@@ -0,0 +1,5 @@
+
+
+::: stac_fastapi.extensions.core.pagination.offset_pagination
+    options:
+      show_source: true
diff --git a/docs/src/api/stac_fastapi/extensions/core/pagination/pagination.md b/docs/src/api/stac_fastapi/extensions/core/pagination/pagination.md
@@ -0,0 +1,5 @@
+
+
+::: stac_fastapi.extensions.core.pagination.pagination
+    options:
+      show_source: true
diff --git a/docs/src/api/stac_fastapi/extensions/core/pagination/request.md b/docs/src/api/stac_fastapi/extensions/core/pagination/request.md
@@ -0,0 +1,6 @@
+
+
+
+::: stac_fastapi.extensions.core.pagination.request
+    options:
+      show_source: true
diff --git a/docs/src/api/stac_fastapi/extensions/core/pagination/token_pagination.md b/docs/src/api/stac_fastapi/extensions/core/pagination/token_pagination.md
@@ -0,0 +1,5 @@
+
+
+::: stac_fastapi.extensions.core.pagination.token_pagination
+    options:
+      show_source: true
diff --git a/docs/src/api/stac_fastapi/extensions/core/query/index.md b/docs/src/api/stac_fastapi/extensions/core/query/index.md
@@ -0,0 +1,8 @@
+# Module stac_fastapi.extensions.core.query
+
+Query Extensions submodule.
+
+## Sub-modules
+
+* [stac_fastapi.extensions.core.query.query](query.md)
+* [stac_fastapi.extensions.core.query.request](request.md)
diff --git a/docs/src/api/stac_fastapi/extensions/core/query/query.md b/docs/src/api/stac_fastapi/extensions/core/query/query.md
@@ -0,0 +1,5 @@
+
+
+::: stac_fastapi.extensions.core.query.query
+    options:
+      show_source: true
diff --git a/docs/src/api/stac_fastapi/extensions/core/query/request.md b/docs/src/api/stac_fastapi/extensions/core/query/request.md
@@ -0,0 +1,6 @@
+
+
+
+::: stac_fastapi.extensions.core.query.request
+    options:
+      show_source: true
diff --git a/docs/src/api/stac_fastapi/extensions/core/sort/index.md b/docs/src/api/stac_fastapi/extensions/core/sort/index.md
@@ -0,0 +1,8 @@
+# Module stac_fastapi.extensions.core.sort
+
+Sort Extensions submodule.
+
+## Sub-modules
+
+* [stac_fastapi.extensions.core.sort.sort](sort.md)
+* [stac_fastapi.extensions.core.sort.request](request.md)
diff --git a/docs/src/api/stac_fastapi/extensions/core/sort/request.md b/docs/src/api/stac_fastapi/extensions/core/sort/request.md
@@ -0,0 +1,6 @@
+
+
+
+::: stac_fastapi.extensions.core.sort.request
+    options:
+      show_source: true
diff --git a/docs/src/api/stac_fastapi/extensions/core/sort/sort.md b/docs/src/api/stac_fastapi/extensions/core/sort/sort.md
@@ -0,0 +1,5 @@
+
+
+::: stac_fastapi.extensions.core.sort.sort
+    options:
+      show_source: true
diff --git a/docs/src/api/stac_fastapi/extensions/core/transaction.md b/docs/src/api/stac_fastapi/extensions/core/transaction.md
@@ -0,0 +1,3 @@
+::: stac_fastapi.extensions.core.transaction
+    options:
+      show_source: true
diff --git a/docs/src/api/stac_fastapi/extensions/index.md b/docs/src/api/stac_fastapi/extensions/index.md
diff --git a/docs/src/api/stac_fastapi/extensions/third_party/bulk_transactions.md b/docs/src/api/stac_fastapi/extensions/third_party/bulk_transactions.md
diff --git a/docs/src/api/stac_fastapi/extensions/third_party/index.md b/docs/src/api/stac_fastapi/extensions/third_party/index.md
diff --git a/docs/src/api/stac_fastapi/index.md b/docs/src/api/stac_fastapi/index.md
diff --git a/docs/src/api/stac_fastapi/types/config.md b/docs/src/api/stac_fastapi/types/config.md
diff --git a/docs/src/api/stac_fastapi/types/conformance.md b/docs/src/api/stac_fastapi/types/conformance.md
diff --git a/docs/src/api/stac_fastapi/types/core.md b/docs/src/api/stac_fastapi/types/core.md
diff --git a/docs/src/api/stac_fastapi/types/errors.md b/docs/src/api/stac_fastapi/types/errors.md
diff --git a/docs/src/api/stac_fastapi/types/extension.md b/docs/src/api/stac_fastapi/types/extension.md
diff --git a/docs/src/api/stac_fastapi/types/index.md b/docs/src/api/stac_fastapi/types/index.md
diff --git a/docs/src/api/stac_fastapi/types/links.md b/docs/src/api/stac_fastapi/types/links.md
diff --git a/docs/src/api/stac_fastapi/types/requests.md b/docs/src/api/stac_fastapi/types/requests.md
diff --git a/docs/src/api/stac_fastapi/types/rfc3339.md b/docs/src/api/stac_fastapi/types/rfc3339.md
diff --git a/docs/src/api/stac_fastapi/types/search.md b/docs/src/api/stac_fastapi/types/search.md
diff --git a/docs/src/api/stac_fastapi/types/stac.md b/docs/src/api/stac_fastapi/types/stac.md
diff --git a/stac_fastapi/api/setup.py b/stac_fastapi/api/setup.py
diff --git a/stac_fastapi/api/stac_fastapi/api/app.py b/stac_fastapi/api/stac_fastapi/api/app.py
diff --git a/stac_fastapi/extensions/setup.py b/stac_fastapi/extensions/setup.py
diff --git a/stac_fastapi/extensions/stac_fastapi/extensions/core/pagination/offset_pagination.py b/stac_fastapi/extensions/stac_fastapi/extensions/core/pagination/offset_pagination.py
diff --git a/stac_fastapi/types/setup.py b/stac_fastapi/types/setup.py
