deploy_mkdocs.yml

name: Publish docs via GitHub Pages

on:
  push:
    branches:
      - main
    paths:
      # Rebuild website when docs have changed or code has changed
      - "README.md"
      - "docs/**"
      - "**.py"
  workflow_dispatch:

jobs:
  build:
    name: Deploy docs
    runs-on: ubuntu-latest

    steps:
      - name: Checkout main
        uses: actions/checkout@v4

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

      - name: Install dependencies
        run: |
          python -m pip install --upgrade pip
          python -m pip install \
            stac_fastapi/types[docs] \
            stac_fastapi/api[docs] \
            stac_fastapi/extensions[docs] \

      - name: update API docs
        run: |
          pdocs as_markdown \
            --output_dir docs/src/api/ \
            --exclude_source \
            --overwrite \
            stac_fastapi

      - name: Deploy docs
        run: mkdocs gh-deploy --force -f docs/mkdocs.yml