documentation.yml

name: "📚 Documentation"

on:
  push:
    branches: [master]
    paths:
      - ".github/workflows/documentation.yml"
      - "docs/*/**"
      - "qgis_resource_sharing/**/*.py"
      - "qgis_resource_sharing/metadata.txt"
      - "requirements/documentation.txt"
    tags:
      - "*"

env:
  PYTHON_VERSION: 3.9

jobs:
  build:
    runs-on: ubuntu-latest

    steps:
      - name: Get source code
        uses: actions/checkout@v4

      - name: Set up Python
        uses: actions/setup-python@v5
        with:
          python-version: ${{ env.PYTHON_VERSION }}
          cache: "pip"
          cache-dependency-path: "requirements/documentation.txt"

      - name: Install dependencies
        run: |
          python -m pip install --upgrade pip setuptools wheel
          python -m pip install -U -r requirements/documentation.txt

      - name: Build doc using Sphinx
        run: sphinx-build -b html -d docs/_build/cache -j auto docs docs/_build/html

      - name: Deploy to GitHub Pages
        run: |
          python -m pip install -U ghp-import
          ghp-import --force --no-history --no-jekyll --push docs/_build/html