# Workflow to deploy mkdocs documentation.

name: docs

on:
  workflow_dispatch:
  workflow_call:
    inputs:
      nightly:
        description: "Optional nightly redirect override"
        default: ""
        required: false
        type: string
  push:
    branches:
      - main
    paths:
      - "docs/**"
      - ".github/workflows/docs.yml"

env:
  # Assign commit authorship to official GitHub Actions bot when pushing to the `gh-pages` branch:
  GIT_USER: "github-actions[bot]"
  GIT_EMAIL: "41898282+github-actions[bot]@users.noreply.github.com"

jobs:
  build-documentation:
    name: Build and deploy docs
    runs-on: ubuntu-latest
    steps:
      - name: Checkout repository
        uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332 # v4.1.7
        with:
          fetch-depth: 0

      - uses: actions/setup-python@0b93645e9fea7318ecaed2b359559ac225c90a2b # v5.3.0
        with:
          python-version: 3.12

      - name: Install Python dependencies
        run: pip install -r docs/requirements.txt

      - name: Configure git user and email
        run: ./scripts/ci/configure_git.sh

      - name: Build and deploy docs with mike
        env:
          MKDOCS_NIGHTLY_RELEASE_OVERRIDE: ${{ inputs.nightly || '' }}
        run: |
          cd docs
          mike deploy nightly --push

  publish-gh-pages:
    needs: [build-documentation]
    uses: ./.github/workflows/publish_github_pages.yml
    secrets: inherit