sphinx to gh workflow #5
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
| # For reference: https://github.com/JamesIves/github-pages-deploy-action | |
| name: Build Sphinx docu. | |
| on: | |
| pull_request | |
| permissions: | |
| contents: read | |
| pages: write | |
| jobs: | |
| build-and-deploy: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Checkout | |
| uses: actions/checkout@v4 | |
| - name: Install and Build HTML | |
| run: | | |
| pip install --upgrade pip | |
| pip install -r docs/requirements.txt | |
| pip install ".[full]" | |
| sphinx-build ./docs/source ./docs/build | |
| - name: Deploy HTML | |
| uses: JamesIves/github-pages-deploy-action@v4 | |
| with: | |
| folder: docs/build/ # The folder the action should deploy. |