Skip to content

Bringing fork into documentation changes branch (ignore) #275

Bringing fork into documentation changes branch (ignore)

Bringing fork into documentation changes branch (ignore) #275

Workflow file for this run

name: Docs CI
on:
push:
pull_request:
jobs:
build:
runs-on: ubuntu-latest
steps:
- name: Avoid git conflicts when tag and branch pushed at same time
if: github.ref_type == 'tag'
run: sleep 60
- name: Checkout
uses: actions/checkout@v4
with:
# Need this to get version number from last tag
fetch-depth: 0
- name: Install system packages
run: sudo apt-get install graphviz
- name: Install python packages
uses: ./.github/actions/install_requirements
- name: Build docs
run: |
mkdir build
tox -e docs
- name: Remove environment.pickle
run: rm build/html/.doctrees/environment.pickle
- name: Upload built docs artifact
uses: actions/upload-artifact@v4
with:
name: docs
path: build
- name: Sanitize ref name for docs version
run: echo "DOCS_VERSION=${GITHUB_REF_NAME//[^A-Za-z0-9._-]/_}" >> $GITHUB_ENV
- name: Move to versioned directory
run: mv build/html .github/pages/$DOCS_VERSION
- name: Write switcher.json
run: python .github/pages/make_switcher.py --add $DOCS_VERSION ${{ github.repository }} .github/pages/switcher.json
- name: Publish Docs to gh-pages
if: github.ref_type == 'tag' || github.ref_name == 'master'
# We pin to the SHA, not the tag, for security reasons.
# https://docs.github.com/en/actions/learn-github-actions/security-hardening-for-github-actions#using-third-party-actions
uses: peaceiris/actions-gh-pages@373f7f263a76c20808c831209c920827a82a2847 # v3.9.3
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: .github/pages
keep_files: true