Skip to content

Commit

Permalink
ci: Add build docs job to prevent pushing broken docs to main. (#93)
Browse files Browse the repository at this point in the history
Prevents broken documentation links by building docs on PRs.
  • Loading branch information
bvanelli authored Nov 3, 2024
1 parent ce0c516 commit f5cbaba
Showing 1 changed file with 17 additions and 0 deletions.
17 changes: 17 additions & 0 deletions .github/workflows/try-build-docs.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
name: Try building the documentation to prevent cross-reference issues

on:
pull_request:

jobs:
try-build-docs:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- uses: actions/setup-python@v4
with:
python-version: "3.11"
- name: Install project dependencies
run: python3 -m pip install --user -r docs/requirements.txt
- name: Try building the documentation
run: mkdocs build

0 comments on commit f5cbaba

Please sign in to comment.