MAINT: Use well-known project URLs #61
This file contains hidden or 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: docs | |
| on: | |
| # Run on pull requests | |
| pull_request: | |
| types: | |
| - opened | |
| - reopened | |
| - synchronize | |
| - ready_for_review | |
| # Run on commits pushed to the main branch | |
| push: | |
| branches: | |
| - main | |
| # Run on calls by other workflows | |
| workflow_call: | |
| # Run on manual workflow triggers | |
| workflow_dispatch: | |
| # Disallow concurrent deployments and in-progress cancellations | |
| concurrency: | |
| group: ${{ github.workflow }} | |
| cancel-in-progress: false | |
| jobs: | |
| # Build job | |
| build: | |
| permissions: | |
| contents: read | |
| runs-on: ubuntu-latest | |
| if: ${{ !github.event.pull_request.draft }} | |
| steps: | |
| - uses: actions/checkout@v5 | |
| - uses: actions/setup-python@v6 | |
| with: | |
| python-version: '3.12' | |
| cache: pip | |
| - name: Install Hatch | |
| uses: pypa/hatch@install | |
| - name: Build documentation | |
| run: hatch run docs:build | |
| - name: Configure GitHub Pages | |
| uses: actions/configure-pages@v5 | |
| - name: Upload documentation | |
| uses: actions/upload-pages-artifact@v4 | |
| with: | |
| path: './docs/_build/html' |