📖 Quickstart #292
Workflow file for this run
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
name: Build/Deploy Documentation | |
on: | |
# So we can trigger manually if needed | |
workflow_dispatch: | |
# To confirm any changes to docs build successfully, without deploying them | |
pull_request: | |
paths: | |
- "docs/**" | |
- ".github/workflows/pages.yaml" | |
- "mkdocs.yml" | |
# Pushes to branches do the full build + deployment | |
push: | |
branches: | |
- main | |
paths: | |
- "docs/**" | |
- ".github/workflows/pages.yaml" | |
- "mkdocs.yml" | |
permissions: | |
contents: write | |
# Don't allow multiple simultaneous instances because that would make deploying the docs nondeterministic | |
concurrency: | |
group: ${{ github.workflow }} | |
jobs: | |
docs: | |
runs-on: ubuntu-latest | |
steps: | |
- uses: actions/checkout@v4 | |
- uses: actions/setup-python@v5 | |
with: | |
python-version: 3.x | |
cache: pip | |
# Deploy on merge | |
- run: make deploy-docs | |
if: github.event_name == 'push' | |
# Only build on everything else | |
- run: make build-docs | |
if: github.event_name != 'push' |