Initialize Sphinx #10
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: "GitHub Pages - Python Sphinx" | |
| on: | |
| push: | |
| pull_request: | |
| # Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages | |
| permissions: | |
| contents: read | |
| pages: write | |
| id-token: write | |
| jobs: | |
| build: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: "Checkout repository" | |
| uses: actions/checkout@c85c95e3d7251135ab7dc9ce3241c5835cc595a9 # v3.5.3 | |
| - name: "Setup PDM" | |
| uses: pdm-project/setup-pdm@c287ac6f97f5fa767aa06946c7f55f40100b78c1 # v3.3 | |
| with: | |
| python-version: "3.11" | |
| cache: true | |
| - name: "Install dependencies" | |
| run: pdm install --group docs | |
| - name: "Build docs" | |
| run: | | |
| cd docs | |
| pdm run make dirhtml | |
| - name: "Upload artifact" | |
| uses: actions/upload-pages-artifact@a753861a5debcf57bf8b404356158c8e1e33150c # v2.0.0 | |
| with: | |
| path: ./docs/build/dirhtml | |
| deploy: | |
| if: ${{ github.ref == 'refs/heads/main' }} | |
| 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@12ab2b16cf43a7a061fe99da74b6f8f11fb77f5b # v2.0.3 |