Skip to content

Commit

Permalink
add workflow to test docs build on pr
Browse files Browse the repository at this point in the history
  • Loading branch information
tjex committed Sep 17, 2024
1 parent 97d2ecf commit a2bc525
Showing 1 changed file with 26 additions and 0 deletions.
26 changes: 26 additions & 0 deletions .github/workflows/build-docs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
# Build the Sphinx docs on PR to catch any issues before merging.
# Deployment happens on push to main with gh-pages.yml
name: Build Docs

on:
pull_request:
branches: [main]

concurrency:
group: "pages"
cancel-in-progress: false

jobs:
pages:
runs-on: ubuntu-20.04
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
permissions:
pages: write
id-token: write
steps:
- id: deployment
uses: sphinx-notes/pages@v3
with:
publish: false

0 comments on commit a2bc525

Please sign in to comment.