Deploy Sphinx to GitHub Pages #1
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: Deploy Sphinx to GitHub Pages | |
| on: | |
| release: | |
| types: [released] | |
| # Allows running this workflow manually from the Actions tab | |
| workflow_dispatch: | |
| # Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages | |
| permissions: | |
| contents: read | |
| pages: write | |
| id-token: write | |
| # Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued. | |
| # However, do NOT cancel in-progress runs as we want to allow these production deployments to complete. | |
| concurrency: | |
| group: "pages" | |
| cancel-in-progress: false | |
| env: | |
| PYTHON_VERSION: 3.10 | |
| POETRY_NO_INTERACTION: 1 | |
| POETRY_VIRTUALENVS_CREATE: false | |
| POETRY_VIRTUALENVS_IN_PROJECT: false | |
| POETRY_VERSION: 1.8.2 | |
| jobs: | |
| build: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Checkout | |
| uses: actions/checkout@v4 | |
| - uses: actions/setup-python@v2 | |
| with: | |
| python-version: ${{ env.PYTHON_VERSION }} | |
| - uses: actions/cache@v3 | |
| with: | |
| path: ~/.cache/pypoetry/virtualenvs | |
| key: ${{ hashFiles('poetry.lock') }} | |
| id: cache | |
| - name: Install poetry | |
| run: | | |
| python -m pip install poetry==$POETRY_VERSION | |
| - name: Install dependencies | |
| run: | | |
| poetry env use $PYTHON_VERSION | |
| poetry install --with dev | |
| if: steps.cache.outputs.cache-hit != 'true' | |
| - name: Verify pre-commit checks | |
| uses: pre-commit/[email protected] | |
| with: | |
| extra_args: --all-files | |
| - name: Test with pytest | |
| run: poetry run python -m pytest ./test | |
| - name: Setup Pages | |
| id: pages | |
| uses: actions/configure-pages@v5 | |
| - name: Build docs with Sphinx | |
| run: make html | |
| working-directory: docs | |
| - name: Upload docs | |
| uses: actions/upload-pages-artifact@v3 | |
| with: | |
| path: docs/build/html | |
| deploy: | |
| environment: | |
| name: github-pages | |
| url: ${{ steps.deployment.outputs.page_url }} | |
| runs-on: ubuntu-latest | |
| needs: build | |
| steps: | |
| - name: Deploy to GitHub Pages | |
| id: deployment | |
| uses: actions/deploy-pages@v4 |