switch to mkdocstrings

.github/workflows/deploy_mkdocs.yml

@@ -24,24 +24,7 @@ jobs:
       - name: Install dependencies
         run: |
           python -m pip install --upgrade pip
-          python -m pip install -e ".[psycopg-binary]"
-          python -m pip install nbconvert mkdocs mkdocs-material mkdocs-jupyter pygments pdocs mike~=2.0
-
-      - name: update API docs
-        run: |
-          pdocs as_markdown \
-            --output_dir docs/src/api \
-            --exclude_source \
-            --overwrite \
-            titiler.pgstac.db \
-            titiler.pgstac.dependencies \
-            titiler.pgstac.extensions \
-            titiler.pgstac.factory \
-            titiler.pgstac.model \
-            titiler.pgstac.mosaic \
-            titiler.pgstac.reader \
-            titiler.pgstac.settings \
-            titiler.pgstac.utils
+          python -m pip install -e ".[psycopg-binary,docs]"
 
       - name: Set module version
         id: module

docs/mkdocs.yml

@@ -54,14 +54,49 @@ nav:
 plugins:
   - search
   - mkdocs-jupyter:
-      include_source: True
+      include_source: true
+      ignore: ["**/.ipynb_checkpoints/*.ipynb"]
+  - mkdocstrings:
+      enable_inventory: true
+      handlers:
+        python:
+          paths: [src]
+          options:
+            filters:
+            - "!^__post_init__"
+            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
+          import:
+            - https://docs.python.org/3/objects.inv
+            - https://numpy.org/doc/stable/objects.inv
+            - https://rasterio.readthedocs.io/en/stable/objects.inv
+            - https://docs.pydantic.dev/latest/objects.inv
+            - https://fastapi.tiangolo.com/objects.inv
+            - https://cogeotiff.github.io/rio-tiler/objects.inv
+            - https://developmentseed.org/morecantile/objects.inv
+            - https://developmentseed.org/titiler/objects.inv
 
 theme:
   name: material
   favicon: img/favicon.ico
   logo: img/logo.png
   features:
+    - content.code.annotate
+    - content.code.copy
     - navigation.indexes
+    - navigation.instant
+    - navigation.tracking
+    - search.suggest
+    - search.share
 
 extra_css:
   - overrides/stylesheets/extra.css

docs/src/api/titiler/pgstac/db.md

@@ -0,0 +1 @@
+::: titiler.pgstac.db

docs/src/api/titiler/pgstac/dependencies.md

@@ -0,0 +1,3 @@
+::: titiler.pgstac.dependencies
+    options:
+       show_source: true

docs/src/api/titiler/pgstac/extensions.md

@@ -0,0 +1 @@
+::: titiler.pgstac.extensions

docs/src/api/titiler/pgstac/factory.md

@@ -0,0 +1 @@
+::: titiler.pgstac.factory

docs/src/api/titiler/pgstac/model.md

@@ -0,0 +1 @@
+::: titiler.pgstac.model

docs/src/api/titiler/pgstac/mosaic.md

@@ -0,0 +1 @@
+::: titiler.pgstac.mosaic

docs/src/api/titiler/pgstac/reader.md

@@ -0,0 +1 @@
+::: titiler.pgstac.reader

docs/src/api/titiler/pgstac/settings.md

@@ -0,0 +1 @@
+::: titiler.pgstac.settings

docs/src/api/titiler/pgstac/utils.md

@@ -0,0 +1 @@
+::: titiler.pgstac.utils

pyproject.toml

@@ -50,6 +50,7 @@ psycopg-binary = [  # pre-compiled C implementation
 ]
 dev = [
     "pre-commit",
+    "bump-my-version",
 ]
 test = [
     "pytest",
@@ -59,6 +60,14 @@ test = [
     "pypgstac>=0.7,<=0.9.1",
     "pytest-postgresql",
 ]
+docs = [
+    "mkdocs>=1.4.3",
+    "mkdocs-jupyter>=0.24.5",
+    "mkdocs-material[imaging]>=9.5",
+    "griffe-inherited-docstrings>=1.0.0",
+    "mkdocstrings[python]>=0.25.1",
+    "mike~=2.0",
+]
 
 [project.urls]
 Homepage = 'https://stac-utils.github.io/titiler-pgstac/'