Merge branch 'master' into master #1
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
name: PhotonVision Sphinx Documentation Checks | |
on: | |
push: | |
branches: [ master ] | |
paths: | |
- 'docs/**' | |
- '.github/**' | |
pull_request: | |
branches: [ master ] | |
paths: | |
- 'docs/**' | |
- '.github/**' | |
jobs: | |
build: | |
runs-on: ubuntu-latest | |
steps: | |
- uses: actions/checkout@v3 | |
- uses: actions/setup-python@v4 | |
with: | |
python-version: '3.11' | |
- name: Install and upgrade pip | |
run: python -m pip install --upgrade pip | |
- name: Install Python dependencies | |
working-directory: docs | |
run: | | |
pip install sphinx sphinx_rtd_theme sphinx-tabs sphinxext-opengraph doc8 | |
pip install -r requirements.txt | |
- name: Check links | |
working-directory: docs | |
run: make linkcheck | |
continue-on-error: true | |
- name: Check lint | |
working-directory: docs | |
run: make lint | |
- name: Compile HTML | |
working-directory: docs | |
run: make html |