doc: add initial documentation #1
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: Documentation | |
| on: [push, pull_request] | |
| jobs: | |
| build: | |
| runs-on: ubuntu-22.04 | |
| steps: | |
| - name: Checkout | |
| uses: actions/checkout@v4 | |
| - name: Install dependencies | |
| run: | | |
| pip install -r doc/requirements.txt | |
| - name: Build | |
| run: | | |
| cd doc | |
| env SPHINXOPTS="-W" make html | |
| - name: Setup pages | |
| if: github.event_name != 'pull_request' | |
| uses: actions/configure-pages@v4 | |
| - name: Upload pages artifact | |
| if: github.event_name != 'pull_request' | |
| uses: actions/upload-pages-artifact@v3 | |
| with: | |
| path: doc/build/html | |
| - name: Upload artifact | |
| if: github.event_name == 'pull_request' | |
| uses: actions/upload-artifact@v4 | |
| with: | |
| path: doc/build/html | |
| deploy: | |
| runs-on: ubuntu-22.04 | |
| needs: build | |
| if: github.event_name != 'pull_request' | |
| permissions: | |
| pages: write | |
| id-token: write | |
| steps: | |
| - name: Deploy to GitHub Pages | |
| uses: actions/deploy-pages@v4 |