add API documentation

stac-utils · Oct 20, 2023 · d08c2be · d08c2be
1 parent ed26e44
commit d08c2be
Show file tree

Hide file tree

Showing 2 changed files with 28 additions and 1 deletion.
diff --git a/.github/workflows/deploy_mkdocs.yml b/.github/workflows/deploy_mkdocs.yml
@@ -31,5 +31,21 @@ jobs:
           python -m pip install .
           python -m pip install nbconvert==6.5.3 mkdocs mkdocs-material mkdocs-jupyter pygments pdocs
 
+      - 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
+
       - name: Deploy docs
         run: mkdocs gh-deploy -f docs/mkdocs.yml --force
diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml
@@ -30,11 +30,22 @@ nav:
     - Custom TileJSON endpoint : "advanced/custom_tilejson.md"
   - Examples:
     - demo: "notebooks/demo.ipynb"
+  - API:
+    - titiler.pgstac:
+      - db: api/titiler/pgstac/db.md
+      - dependencies: api/titiler/pgstac/dependencies.md
+      - extensions: api/titiler/pgstac/extensions.md
+      - factory: api/titiler/pgstac/factory.md
+      - model: api/titiler/pgstac/model.md
+      - mosaic: api/titiler/pgstac/mosaic.md
+      - reader: api/titiler/pgstac/reader.md
+      - settings: api/titiler/pgstac/settings.md
+      - utils: api/titiler/pgstac/utils.md
   - Migration Guides:
     - v0.8 -> v1.0: 'migrations/v1_migration.md'
-  - Performance Benchmarks: benchmark.html
   - Development - Contributing: "contributing.md"
   - Release notes: "release-notes.md"
+  - Performance Benchmarks: benchmark.html
 
 plugins:
   - search