Merge pull request #134 from gmathiou4/Relative-links-confuse-PyPi #723
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: CI Documentation | |
on: [push, pull_request] | |
jobs: | |
build: | |
runs-on: ubuntu-20.04 | |
strategy: | |
max-parallel: 4 | |
matrix: | |
python-version: [3.9] | |
steps: | |
- name: Checkout code | |
uses: actions/checkout@v2 | |
- name: Set up Python ${{ matrix.python-version }} | |
uses: actions/setup-python@v2 | |
with: | |
python-version: ${{ matrix.python-version }} | |
- name: Give permission to run scripts | |
run: chmod +x ./docs/scripts/doc8_style_check.sh | |
- name: Install Dependencies | |
run: pip install -e .[docs] | |
- name: Check Sphinx Documentation build minimally | |
working-directory: ./docs | |
run: sphinx-build -E -W source build | |
- name: Check for documentation style errors | |
working-directory: ./docs | |
run: ./scripts/doc8_style_check.sh | |