deploy_mkdocs.yml

name: Publish docs via GitHub Pages

on:
  push:
    branches:
      - main
    paths:
      # Only rebuild website when docs have changed
      - 'README.md'
      - 'CHANGES.md'
      - 'CONTRIBUTING.md'
      - 'docs/**'
      - '.github/workflows/deploy_mkdocs.yml'

jobs:
  build:
    name: Deploy docs
    runs-on: ubuntu-latest
    steps:
      - name: Checkout master
        uses: actions/checkout@v4

      - name: Set up Python 3.8
        uses: actions/setup-python@v5
        with:
          python-version: 3.8

      - name: Install dependencies
        run: |
          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:password@0.0.0.0: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