gh-pages.yml

# Deploy Sphinx content to GitHub Pages
name: Docs

on:
  # Runs on pushes targeting the default branch
  push:
    paths:
      - .github/workflows/gh-pages.yml
      - build_docs.py
      - docs/**
      - src/**
    branches:
      - 'main'

  release:
    types:
      - published

  workflow_dispatch:

# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
permissions:
  contents: read
  pages: write
  id-token: write

# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
concurrency:
  group: "pages"
  cancel-in-progress: false

jobs:
  build:
    name: Build the documentation with Sphinx
    runs-on: ubuntu-latest
    environment:
      name: github-pages
    steps:
      - name: Harden Runner
        uses: step-security/harden-runner@91182cccc01eb5e619899d80e4e971d6181294a7 # v2.10.1
        with:
          egress-policy: audit

      - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
        with:
          fetch-depth: 0

      - run: git fetch origin main

      - name: troubleshooting
        run: |
          git branch
          git remote -v

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

      - name: Install dependencies
        run: |
          sudo apt-get install -y doxygen graphviz
          python -m pip install --upgrade pip
          python -m pip install -r requirements.txt -r docs/requirements.txt

      - name: Checkout docs root
        run:
          git clone https://github.com/sandialabs/sansmic-ci.git
          python -m pip install -r sansmic-ci/docs/requirements.txt

      - name: Build documentation
        run: |
          python -m pip install -e .[formats]
          git config set versionsort.suffix -rc
          export SANSMIC_SPHINX_VERSION=dev
          python sansmic-ci/build_switcher.py
          export SANSMIC_STABLE_VERSION=`cat stable.txt`
          mkdir sansmic-ci/docs/$SANSMIC_STABLE_VERSION
          touch sansmic-ci/docs/$SANSMIC_STABLE_VERSION/userman.rst
          touch sansmic-ci/docs/$SANSMIC_STABLE_VERSION/refman.rst
          cat sansmic-ci/docs/index.tpl | sed s/BUILD_SCRIPT_REPLACE/$SANSMIC_STABLE_VERSION/g > sansmic-ci/docs/index.rst

          sphinx-build -b html -d doctrees/root/ sansmic-ci/docs/ html/
          mkdir docs/_build
          mkdir docs/_build/doxyxml
          mkdir html/
          sphinx-build -b html -d doctrees/latest docs/ html/latest
          for TAG in `git tag --list "v*.*.*" --sort=-version:refname`
          do
            rm -rf docs
            git checkout -f $TAG
            export SANSMIC_SPHINX_VERSION=$TAG
            cp -f sansmic-ci/docs/_static/* docs/_static/
            cp -f sansmic-ci/docs/conf.py docs/conf.py
            sphinx-build -q -b html -d doctrees/$TAG docs html/$TAG
          done

      - name: Upload artifact
        uses: actions/upload-pages-artifact@56afc609e74202658d3ffba0e8f6dda462b719fa # v3.0.1
        if: success() || failure()
        with:
          path: 'html/'

  deploy:
    name: Deploy documentation to GitHub Pages
    needs: [build]
    if: ${{ always() }}
    environment:
      name: github-pages
      url: ${{ steps.deployment.outputs.page_url }}
    runs-on: ubuntu-latest
    steps:
      - name: Harden Runner
        uses: step-security/harden-runner@91182cccc01eb5e619899d80e4e971d6181294a7 # v2.10.1
        with:
          disable-sudo: true
          egress-policy: block
          allowed-endpoints: >
            api.github.com:443

      - name: Setup Pages
        uses: actions/configure-pages@983d7736d9b0ae728b81ab479565c72886d7745b # v5.0.0

      - name: Deploy to GitHub Pages
        id: deployment
        uses: actions/deploy-pages@d6db90164ac5ed86f2b6aed7e0febac5b3c0c03e # v4.0.5