add API docs

.github/workflows/docs.yml

@@ -31,11 +31,14 @@ jobs:
         with:
           python-version: '3.12'
 
-      - name: Install Python requirements
+      - name: Install Python docs requirements
         run: |
           pip install -r requirements.txt
           pip install -r requirements-dev.txt
 
+      - name: Install Django-OAPIF
+        run: python -m pip install -e ..
+
       - name: Build documentation
         run: mkdocs build
 

docs/content/api.md

@@ -0,0 +1,3 @@
+# API documentation
+
+::: django_oapif.register_oapif_viewset

docs/content/quick-start.md

@@ -40,7 +40,7 @@ urlpatterns += [
 # models.py
 
 from django.contrib.gis.db import models
-from django_oapif import register
+from django_oapif import register_oapif_viewset
 
 
 @register_oapif_viewset()

docs/mkdocs.yml

@@ -51,6 +51,7 @@ nav:
   - Home: index.md
   - Quick start: quick-start.md
   - Demo: demo.md
+  - API: api.md
   - Permissions: permissions.md
   - Test and conformance: tests.md
 
@@ -64,10 +65,12 @@ markdown_extensions:
   - fancyboxmd
   - sane_lists
   - admonition
+  - codehilite
   - pymdownx.details
   - pymdownx.tabbed:
       alternate_style: true
   - pymdownx.superfences
 
 plugins:
   - search
+  - mkdocstring

docs/requirements.txt

@@ -1,3 +1,4 @@
+mkdocstrings[python]
 mkdocs-material==9.5.9
 mkdocs-video==1.5.0
 fancyboxmd==1.1.0