Skip to content

Merge pull request #291 from corenting/dependabot/github_actions/prod… #57

Merge pull request #291 from corenting/dependabot/github_actions/prod…

Merge pull request #291 from corenting/dependabot/github_actions/prod… #57

Workflow file for this run

name: "Documentation"
on:
push:
branches:
- "master"
tags:
- "v*"
pull_request:
branches:
- "master"
jobs:
build:
name: Build sphinx documentation
runs-on: ubuntu-latest
permissions:
contents: write
steps:
- name: Checkout code
uses: actions/checkout@v4
- name: Install Poetry
run: pipx install poetry
- name: Setup Python
uses: actions/setup-python@v5
with:
python-version: 3.12
cache: "poetry"
- name: Setup environment
run: poetry install
- name: Build HTML
run: poetry run sphinx-build -M html docs docs/build
- name: Upload artifacts
uses: actions/upload-pages-artifact@v3
with:
path: docs/build/html/
deploy:
name: Deploy documentation
runs-on: ubuntu-latest
needs: build
if: startsWith(github.ref, 'refs/tags/v')
permissions:
pages: write # to deploy to Pages
id-token: write # to verify the deployment originates from an appropriate source
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
steps:
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v4 # or the latest "vX.X.X" version tag for this action