Add a tutorial introduction. #14
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 Docs" | |
| on: | |
| - workflow_dispatch | |
| - pull_request | |
| jobs: | |
| check-docs: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - name: Set up Python 3.11 | |
| uses: actions/setup-python@v5 | |
| with: | |
| python-version: '3.11' | |
| - name: Install dependencies and local packages | |
| run: python -m pip install sphinx pydata-sphinx-theme | |
| - name: Build HTML documentation with Sphinx | |
| run: | | |
| make html | |
| make html SPHINXOPTS="-W --keep-going -n" | |
| working-directory: docs | |
| - uses: actions/upload-artifact@v4 | |
| with: | |
| name: documentation | |
| path: docs/build/html | |
| retention-days: 7 |