documentation.yaml

name: docs

on:
  push:
    branches: ["main"]
  pull_request:
    branches: ["main"]

jobs:

  docs:
    name: "Deploy docs"
    runs-on: ubuntu-22.04
    if: ${{ github.event_name == 'push' && github.ref == 'refs/heads/main' }}

    steps:
      - uses: actions/checkout@v4

      - name: Deploy docs
        uses: mhausenblas/mkdocs-deploy-gh-pages@master
        env:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
          REQUIREMENTS: docs/doc-requirements.txt

  docs-build:
    name: "Test docs build"
    runs-on: ubuntu-22.04
    if: ${{ github.event_name != 'push' || github.ref != 'refs/heads/main' }}

    steps:
      - uses: actions/checkout@v4

      - uses: actions/setup-python@v5
        with:
          python-version: '3.10'
          cache: pip

      - name: Install current fractal
        run: python -m pip install -e .

      - name: Install dependencies
        run: python -m pip install -r docs/doc-requirements.txt

      - name: MKDocs build
        run: mkdocs build --config-file mkdocs.yml --strict