Skip to content

Commit

Permalink
automation: add workflow to fail on warnings during docs build
Browse files Browse the repository at this point in the history
  • Loading branch information
consideRatio committed Apr 16, 2024
1 parent 295c091 commit 6adf419
Show file tree
Hide file tree
Showing 2 changed files with 36 additions and 1 deletion.
35 changes: 35 additions & 0 deletions .github/workflows/test-docs.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
# This is a GitHub workflow defining a set of jobs with a set of steps.
# ref: https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions
#
name: Test docs

on:
pull_request:
paths:
- "docs/**"
- "**/test-docs.yaml"
push:
paths:
- "docs/**"
- "**/test-docs.yaml"
branches-ignore:
- "dependabot/**"
- "pre-commit-ci-update-config"
workflow_dispatch:

jobs:
test-docs:
runs-on: ubuntu-22.04
steps:
- uses: actions/checkout@v4
- uses: actions/setup-python@v5
with:
python-version: "3.11"

- name: Install deps
run: pip install -r docs/requirements.txt

- name: make linkcheck
run: |
cd docs
make dirhtml SPHINXOPTS='--color -W --keep-going'
2 changes: 1 addition & 1 deletion docs/environment.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,6 @@ name: infrastructure-docs
channels:
- conda-forge
dependencies:
- python=3.10
- python=3.11
- pip:
- -r requirements.txt

0 comments on commit 6adf419

Please sign in to comment.