Repository navigation
Deploy Documentation to GitHub Pages #188
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: Deploy Documentation to GitHub Pages | |
| # Builds the auto-generated ProperDocs reference site (driven by | |
| # docs/gen_ref_pages.py + properdocs.yml + mkdocstrings) and deploys it to | |
| # https://honeyhiveai.github.io/python-sdk/. Because the reference is | |
| # generated from docstrings in src/honeyhive/, docstring-only changes ship | |
| # as doc changes through this same workflow — no separate generation step. | |
| # | |
| # --strict is intentionally OFF to match the Makefile: there are pre-existing | |
| # griffe / mkdocstrings warnings in the source whose cleanup is tracked as a | |
| # follow-up. Re-add --strict to the build step here once those warnings are | |
| # resolved so doc rot can't accumulate silently. | |
| on: | |
| push: | |
| branches: [federated-sdk-release-candidate] | |
| paths: | |
| - 'docs/**' | |
| - 'src/honeyhive/**' | |
| - 'properdocs.yml' | |
| - 'pyproject.toml' | |
| - 'uv.lock' | |
| - '.github/workflows/docs-deploy.yml' | |
| workflow_dispatch: | |
| permissions: | |
| contents: read | |
| pages: write | |
| id-token: write | |
| # Avoid concurrent deploys stomping on each other; let an in-flight deploy | |
| # finish before starting the next one rather than cancelling it. | |
| concurrency: | |
| group: "pages-${{ github.ref }}" | |
| cancel-in-progress: false | |
| jobs: | |
| build: | |
| name: Build site | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v6 | |
| - name: Install uv | |
| uses: astral-sh/setup-uv@v6 | |
| with: | |
| enable-cache: true | |
| - name: Build site | |
| run: uv run --extra docs properdocs build | |
| - uses: actions/upload-pages-artifact@v4 | |
| with: | |
| path: site | |
| deploy: | |
| name: Deploy to GitHub Pages | |
| needs: build | |
| runs-on: ubuntu-latest | |
| environment: | |
| name: github-pages | |
| url: ${{ steps.deployment.outputs.page_url }} | |
| steps: | |
| - id: deployment | |
| uses: actions/deploy-pages@v4 |