diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index 4e30e92..1f6012a 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -31,18 +31,21 @@ 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 - uses: actions/upload-artifact@v4 if: ${{ github.event_name == 'pull_request' }} with: - name: docs + name: Django-OAPIF-documentation path: docs/site if-no-files-found: error diff --git a/docs/content/api.md b/docs/content/api.md new file mode 100644 index 0000000..6b96f4e --- /dev/null +++ b/docs/content/api.md @@ -0,0 +1,3 @@ +# API documentation + +::: django_oapif.decorators diff --git a/docs/content/quick-start.md b/docs/content/quick-start.md index 91ff93e..fcfd75b 100644 --- a/docs/content/quick-start.md +++ b/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.decorators import register_oapif_viewset @register_oapif_viewset() diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml index 8b25bcc..1da15d8 100644 --- a/docs/mkdocs.yml +++ b/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,6 +65,7 @@ markdown_extensions: - fancyboxmd - sane_lists - admonition + - codehilite - pymdownx.details - pymdownx.tabbed: alternate_style: true @@ -71,3 +73,4 @@ markdown_extensions: plugins: - search + - mkdocstrings diff --git a/docs/requirements.txt b/docs/requirements.txt index 49a1551..2fff6d6 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -1,3 +1,4 @@ +mkdocstrings[python] mkdocs-material==9.5.9 mkdocs-video==1.5.0 fancyboxmd==1.1.0