Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
49 changes: 49 additions & 0 deletions .github/workflows/doc.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
name: Docs
on:
push:
paths:
- 'doc/'
- '.github/workflows/doc.yml'
pull_request:
paths:
- 'doc/'
- '.github/workflows/doc.yml'
workflow_dispatch:

concurrency:
group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.sha }}
cancel-in-progress: true

jobs:
doc:
runs-on: ubuntu-latest
steps:
- name: Checkout code
uses: actions/checkout@v4

- name: Setup python binary
uses: actions/setup-python@v5
with:
python-version: '3'
cache: 'pip'
cache-dependency-path: 'doc/requirements.txt'

- name: Install dependencies
run: pip install -r doc/requirements.txt

- name: Add sphinx-build problem matcher
uses: sphinx-doc/[email protected]

- name: Add sphinx-lint problem matcher
uses: rffontenelle/[email protected]

- name: Build docs
run: make -C doc html O='--keep-going --fail-on-warning --nitpicky'

- name: Lint docs
if: always()
run: sphinx-lint doc/

- name: Check links
if: always()
run: make -C doc linkcheck O='--keep-going'
2 changes: 2 additions & 0 deletions doc/requirements.txt
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
sphinx
sphinx_rtd_theme>=1.3
sphinx-click
sphinx-lint
.
Loading