adding basic draft for SE05 specific documentation #412
Workflow file for this run
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: Pull Request Checker | |
| on: | |
| pull_request: | |
| jobs: | |
| syntax-check: | |
| name: Check syntax | |
| runs-on: ubuntu-latest | |
| container: python:3.11 | |
| continue-on-error: true | |
| steps: | |
| - name: Checkout repository | |
| uses: actions/checkout@v3 | |
| - name: Create virtual environment | |
| run: make venv | |
| - name: Syntax check | |
| run: | | |
| . venv/bin/activate | |
| rstcheck --recursive --ignore-directives "tabs" source/ | |
| build-error-check: | |
| name: Check build error | |
| runs-on: ubuntu-latest | |
| container: python:3.11 | |
| steps: | |
| - name: Checkout repository | |
| uses: actions/checkout@v3 | |
| - name: Create virtual environment | |
| run: make venv | |
| - name: Build documentation | |
| run: | | |
| . venv/bin/activate | |
| sphinx-build -W -j 1 -a -D language='en' -b html source dist/en |