gh-pages.yaml

name: GitHub Pages sphinx deployment

on:
  push:
    branches:
      - release
  workflow_dispatch:

# NOTE: If you modify this file to install a package with pip or apt, please
#       verify if we need the same package added to our readthedocs build.
jobs:
  # Ref: https://stackoverflow.com/questions/57989790/using-github-actions-to-publish-documentation
  deploy:
    runs-on: ubuntu-latest
    permissions:
      contents: write
    steps:
      - uses: actions/checkout@v6

      - name: Install apt packages
        run: |
          sudo apt-get install -y graphviz tree

      - name: Set up Python
        uses: actions/setup-python@v6
        with:
          python-version: '3.14'
          cache: pip

      - name: Install dependencies
        run: python3 -m pip install -U -e ".[all]"

      - name: pre-pull container images
        run: make container-pull

      - name: Build documentation
        run: |
          mkdir -p _build/html
          make html
          for lang in en es pt_BR pt_PT ja zh_Hans; do
            make html BUILDDIR=_build/${lang} SPHINXOPTS="-D language=${lang} -j auto"
            mv _build/${lang}/html _build/html/${lang}
          done

      - name: Deploy
        uses: peaceiris/actions-gh-pages@v4
        with:
          github_token: ${{ secrets.GITHUB_TOKEN }}
          publish_dir: ./_build/html/
          publish_branch: gh-pages