Merge pull request #47 from VisLab/fix_badges #95
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: Deploy Documentation | |
| on: | |
| push: | |
| branches: [ main ] | |
| pull_request: | |
| branches: [ main ] | |
| permissions: | |
| contents: read | |
| pages: write | |
| id-token: write | |
| concurrency: | |
| group: "pages" | |
| cancel-in-progress: false | |
| jobs: | |
| build: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6 | |
| with: | |
| fetch-depth: 0 | |
| - name: Install uv | |
| uses: astral-sh/setup-uv@37802adc94f370d6bfd71619e3f0bf239e1f3b78 # v7 | |
| with: | |
| python-version: '3.10' | |
| enable-cache: true | |
| cache-dependency-glob: "**/pyproject.toml" | |
| - name: Create virtual environment | |
| run: | | |
| uv venv --clear .venv | |
| echo "$GITHUB_WORKSPACE/.venv/bin" >> $GITHUB_PATH | |
| - name: Install dependencies | |
| run: uv pip install -e ".[docs]" | |
| - name: Configure Git for GitHub Pages | |
| run: | | |
| git config user.name github-actions | |
| git config user.email [email protected] | |
| - name: Build documentation | |
| run: | | |
| sphinx-build -b html docs docs/_build/html | |
| - name: Setup Pages | |
| uses: actions/configure-pages@45bfe0192ca1faeb007ade9deae92b16b8254a0d # v6 | |
| - name: Upload artifact | |
| uses: actions/upload-pages-artifact@7b1f4a764d45c48632c6b24a0339c27f5614fb0b # v4 | |
| with: | |
| path: ./docs/_build/html | |
| #------------------------------------------------ | |
| # Deploy Job: Deploys the built site | |
| #------------------------------------------------ | |
| deploy: | |
| # This job depends on the 'build' job completing successfully | |
| needs: build | |
| # Only deploy when pushing to main branch, not on pull requests | |
| if: github.event_name == 'push' && github.ref == 'refs/heads/main' | |
| runs-on: ubuntu-latest | |
| # Specify the deployment environment | |
| environment: | |
| name: github-pages | |
| # The URL will be automatically set by the deployment step's output | |
| url: ${{ steps.deployment.outputs.page_url }} | |
| steps: | |
| - name: Deploy to GitHub Pages | |
| # This is the official action for deploying the artifact to GitHub Pages | |
| id: deployment | |
| uses: actions/deploy-pages@cd2ce8fcbc39b97be8ca5fce6e763baed58fa128 # v5 |