add CI lint #234
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: Check documentation | |
| on: | |
| push: | |
| paths: | |
| - 'docs/**' | |
| - '.readthedocs.yaml' | |
| - '.github/workflows/check_doc.yml' | |
| jobs: | |
| build: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - uses: actions/setup-python@v5 | |
| with: | |
| python-version: '3.8' | |
| - name: install ppanggolin with python deps and doc deps | |
| run: pip install .[doc,python_deps] | |
| - name: Complete workflow | |
| shell: bash -l {0} | |
| run: | | |
| cd docs/ | |
| sphinx-build -b html . build/ | |
| # Great extra actions to compose with: | |
| # Create an artifact of the html output. | |
| - uses: actions/upload-artifact@v4 | |
| with: | |
| name: DocumentationHTML | |
| path: docs/build/ |