Skip to content

Commit

Permalink
Add Github action for linting documentation
Browse files Browse the repository at this point in the history
Simply runs the Sphinx output targets for linting (dummy), which
compiles the docs without outputting anything, and checking that all
links are valid.
  • Loading branch information
Rycieos committed Jan 21, 2021
1 parent 110047b commit 30f977b
Showing 1 changed file with 24 additions and 0 deletions.
24 changes: 24 additions & 0 deletions .github/workflows/docs-lint.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
name: Lint Documentation
on:
push:
paths:
- 'docs/**'
pull_request:
jobs:
docs-lint:
name: Lint Documentation
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
with:
fetch-depth: 1
- name: Set up Python
uses: actions/setup-python@v2
with:
python-version: '3.x'
- name: Lint
run: |
cd docs/
python3 -m pip install -r requirements.txt
make dummy
make linkcheck

0 comments on commit 30f977b

Please sign in to comment.