docs.yml

name: Docs

on:
  push:
    branches:
      - main
      - docs

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

      - name: Set up Python
        uses: actions/setup-python@v4.3.0
        with:
          python-version: "3.10"

      - name: Requirements
        run: |
          sudo apt-get update
          sudo apt-get install doxygen python3-sphinx graphviz
          python -m pip install --upgrade pip
          pip install -r docs/requirements.txt

      - name: Build release docs
        run: |
          HEAD=$(git rev-parse HEAD)
          git fetch --all --tags
          cd docs
          for version in $(git tag -l); do
              echo "Processing $version:"
              git checkout $version
              pip install --force-reinstall -v "ipctk==$version"
              sphinx-build source build/html/$version -D html_theme_options.version_dropdown=true
          done
          pip uninstall -y ipctk
          git checkout $HEAD
          cp source/_static/versions.json build/html/
          cd ..

      - name: Build ipctk
        run: pip install --verbose .

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

      - name: Deploy
        uses: JamesIves/github-pages-deploy-action@v4.4.1
        with:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
          BRANCH: gh-pages # The branch the action should deploy to.
          FOLDER: docs/build/html # The folder the action should deploy.