docs.yml

name: Docs

on:
  workflow_dispatch:
  push:
    branches:
      - main
      - docs

jobs:
  Docs:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout repository
        uses: actions/checkout@v6
        with:
          fetch-depth: 10

      - name: Set up Python
        uses: actions/setup-python@v6
        with:
          python-version: "3.13"

      - name: Requirements
        run: |
          sudo apt-get update
          sudo apt-get install doxygen python3-sphinx graphviz ccache
          echo 'CACHE_PATH=~/.cache/ccache' >> "$GITHUB_ENV"
          python -m pip install --upgrade pip
          pip install -r docs/requirements.txt

      - name: Cache Build
        id: cache-build
        uses: actions/cache@v5
        with:
          path: ${{ env.CACHE_PATH }}
          key: docs-cache
          restore-keys: Linux-Python-cache

      - name: Prepare Ccache
        run: |
          ccache --max-size=1.0G
          ccache -V && ccache --show-config
          ccache --show-stats && ccache --zero-stats

      - name: Copy release docs
        run: |
          git fetch --all --tags

          # Checkout the versioned docs from the gh-pages branch
          git checkout origin/gh-pages -- 'v*'

          # Move the versioned docs to the build directory
          mkdir -p docs/build/html
          mv v* docs/build/html/

          # Copy the custom.css to each version's build
          for version in $(git tag -l); do
              if [ -e docs/build/html/$version/_static/css/ ]; then
                  cp docs/source/_static/css/custom.css docs/build/html/$version/_static/css/
              fi
          done

          # Copy versions.json to the root of the build
          cp docs/source/_static/versions.json docs/build/html/

      - name: Build new release docs
        run: |
          HEAD=$(git rev-parse HEAD)
          git fetch --all --tags
          cd docs
          for version in $(git tag -l); do
              if [ -d build/html/$version ]; then
                  echo "Skipping $version (already exists)"
                  continue
              fi

              echo "Processing $version:"
              git checkout $version

              # Fix links
              grep -rli 'url = {https://ipc-sim.github.io/ipc-toolkit/}' ../* | xargs -i@ sed -i 's/ipc-sim.github.io\/ipc-toolkit\//github.com\/ipc-sim\/ipc-toolkit/g' @
              grep -rli 'ipc-sim.github.io/ipc-toolkit' ../* | xargs -i@ sed -i 's/ipc-sim.github.io\/ipc-toolkit/ipctk.xyz/g' @

              pip install --force-reinstall -v "ipctk==$version"
              sphinx-build source build/html/$version \
                -D html_theme_options.version_dropdown=true \
                -D html_theme_options.version_json=https://ipctk.xyz/versions.json

              # Discard changes
              git reset --hard
          done
          pip uninstall -y ipctk
          git checkout $HEAD
          # Copy the custom.css to each version's build
          for version in $(git tag -l); do
              if [ ! -f build/html/$version/_static/css/custom.css ]; then
                  cp source/_static/css/custom.css build/html/$version/_static/css/
              fi
          done
          cd ..

      - name: Build ipctk
        run: |
          pip install --verbose .
          ccache --show-stats

      - name: Build docs
        run: |
          cd docs
          make html
          cd build/html
          touch .nojekyll

      - name: Deploy
        uses: JamesIves/github-pages-deploy-action@v4
        with:
          branch: gh-pages # The branch the action should deploy to.
          folder: docs/build/html # The folder the action should deploy.