High-level Client with Image Handling etc. #2
Workflow file for this run
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: Build and Deploy Documentation | |
| on: | |
| push: | |
| branches: [main, master] | |
| paths: | |
| - "docs/**" | |
| - "src/**" | |
| - "examples/**" | |
| - "README.md" | |
| - "pyproject.toml" | |
| - ".github/workflows/docs.yml" | |
| pull_request: | |
| branches: [main, master] | |
| paths: | |
| - "docs/**" | |
| - "src/**" | |
| - "examples/**" | |
| - "README.md" | |
| - "pyproject.toml" | |
| - ".github/workflows/docs.yml" | |
| workflow_dispatch: | |
| inputs: | |
| reason: | |
| description: "Reason for manual documentation build" | |
| required: false | |
| default: "Manual trigger" | |
| permissions: | |
| contents: read | |
| pages: write | |
| id-token: write | |
| concurrency: | |
| group: "pages" | |
| cancel-in-progress: false | |
| jobs: | |
| build: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Checkout | |
| uses: actions/checkout@v4 | |
| with: | |
| fetch-depth: 0 | |
| - name: Install uv | |
| uses: astral-sh/setup-uv@v6 | |
| with: | |
| enable-cache: true | |
| - name: Set up Python | |
| run: uv python install | |
| - name: Install dependencies | |
| run: uv sync --locked --group docs | |
| - name: Build documentation | |
| run: | | |
| cd docs | |
| uv run make clean | |
| uv run make html | |
| - name: Setup Pages | |
| uses: actions/configure-pages@v4 | |
| if: github.ref == 'refs/heads/main' || github.ref == 'refs/heads/master' | |
| - name: Upload artifact | |
| uses: actions/upload-pages-artifact@v3 | |
| if: github.ref == 'refs/heads/main' || github.ref == 'refs/heads/master' | |
| with: | |
| path: docs/_build/html | |
| - name: Upload build artifacts for debugging | |
| uses: actions/upload-artifact@v4 | |
| if: failure() | |
| with: | |
| name: docs-build-artifacts | |
| path: | | |
| docs/_build/ | |
| docs/*.log | |
| deploy: | |
| environment: | |
| name: github-pages | |
| url: ${{ steps.deployment.outputs.page_url }} | |
| runs-on: ubuntu-latest | |
| needs: build | |
| if: github.ref == 'refs/heads/main' || github.ref == 'refs/heads/master' | |
| steps: | |
| - name: Deploy to GitHub Pages | |
| id: deployment | |
| uses: actions/deploy-pages@v4 |