Skip to content

chore(deps): bump actions/setup-python from 5 to 7 #30

chore(deps): bump actions/setup-python from 5 to 7

chore(deps): bump actions/setup-python from 5 to 7 #30

Workflow file for this run

# This workflow's name, displayed in the GitHub Actions UI.
name: "Docs Build and Deploy"
# Build on every PR (validation) and on pushes to main (validation + deploy).
on:
pull_request:
push:
branches:
- main
# Define the jobs that will run as part of this workflow.
jobs:
# Job to build the Sphinx documentation. Runs for PRs and pushes to main.
build-docs:
runs-on: ubuntu-latest
# `contents: read` is needed to checkout the repository.
permissions:
contents: read
steps:
- name: Checkout repository
uses: actions/checkout@v7
- name: Set up Python
uses: actions/setup-python@v7
with:
python-version: '3.x'
- name: Install Sphinx and dependencies
run: |
python -m pip install --upgrade pip
pip install -r requirements.txt
- name: Build Sphinx HTML documentation
run: make html
# Only package the build for deployment when it will actually be deployed.
- name: Upload GitHub Pages artifact
if: github.event_name == 'push' && github.ref == 'refs/heads/main'
uses: actions/upload-pages-artifact@v5
with:
path: "_build/html/"
# Job to deploy the built documentation to GitHub Pages.
# Only runs on pushes to main, never for pull requests (including forks,
# which don't have the required Pages/OIDC token permissions anyway).
deploy-pages:
needs: build-docs
if: github.event_name == 'push' && github.ref == 'refs/heads/main'
runs-on: ubuntu-latest
permissions:
pages: write
id-token: write
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
steps:
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v5