update doc gen

Author: vincentsarago

.github/workflows/deploy_mkdocs.yml

@@ -30,27 +30,5 @@ jobs:
           python -m pip install --upgrade pip
           python -m pip install -e .["docs"]
 
-      - name: Create API docs
-        env:
-          # we need to set a fake PG url or import will fail
-          DATABASE_URL: postgresql://username:[email protected]:5439/postgis
-        run: |
-          pdocs as_markdown \
-            --output_dir docs/src/api \
-            --exclude_source \
-            --overwrite \
-            tipg.filter.evaluate \
-            tipg.filter.filters \
-            tipg.resources.enums \
-            tipg.resources.response \
-            tipg.collections \
-            tipg.database \
-            tipg.dependencies \
-            tipg.errors \
-            tipg.factory \
-            tipg.middleware \
-            tipg.model \
-            tipg.settings
-
       - name: Deploy docs
         run: mkdocs gh-deploy --force -f docs/mkdocs.yml

docs/mkdocs.yml

@@ -28,8 +28,7 @@ nav:
     - "TiPg Vector Tiles server": advanced/ogc_tiles_server.md
     - "TiPg Features server": advanced/ogc_features_server.md
   - API:
-    - db: api/tipg/db.md
-    - dbmodel: api/tipg/dbmodel.md
+    - database: api/tipg/database.md
     - dependencies: api/tipg/dependencies.md
     - errors: api/tipg/errors.md
     - factory: api/tipg/factory.md
@@ -48,6 +47,29 @@ nav:
 
 plugins:
   - search
+  - 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://docs.pydantic.dev/latest/objects.inv
+            - https://fastapi.tiangolo.com/objects.inv
 
 theme:
   name: material

pyproject.toml

@@ -56,10 +56,11 @@ server = [
     "uvicorn[standard]>=0.12.0,<0.19.0",
 ]
 docs = [
+    "black>=23.10.1",
     "mkdocs",
-    "mkdocs-material",
-    "pygments",
-    "pdocs",
+    "mkdocs-material[imaging]>=9.5",
+    "griffe-inherited-docstrings>=1.0.0",
+    "mkdocstrings[python]>=0.25.1",
 ]
 
 [project.urls]