Repository navigation
ci(docs): replace Sphinx workflows with ProperDocs deploy - #352
Merged
Merged
Conversation
skylarmb
force-pushed
the
ci/properdocs-deploy
branch
from
May 1, 2026 22:46
1261cc2 to
2258db1
Compare
skylarmb
marked this pull request as ready for review
May 1, 2026 22:48
The SDK ships an auto-generated ProperDocs/MkDocs reference site driven by docs/gen_ref_pages.py + properdocs.yml (landed in release v1.0.0rc22). The existing Sphinx-shaped CI in this repo would have failed on first run because the inputs it depends on (docs/conf.py, the Divio tutorials/how-to/ reference/explanation tree, the Sphinx Makefile) no longer exist. This change replaces docs-deploy.yml with a minimal Pages-deploy workflow that mirrors `make docs-build` (uv run --extra docs properdocs build) and ships the resulting site/ directory through actions/upload-pages-artifact + actions/deploy-pages@v4. Removed: - docs-preview.yml: Sphinx-only PR artifact upload; can be reintroduced later as an MkDocs-based PR preview if useful. - docs-validation.yml: post-deploy live-URL nav check that hard-codes Sphinx-named pages (tutorials/index.html, etc.) which no longer exist. - docs-versioned.yml: mike-based versioned docs; not shipping versioning day one. Mike works fine with MkDocs if/when we want it back. Kept untouched: - sync-changelog-to-docs.yml: independent of the Pages site this workflow deploys. --strict is intentionally OFF on properdocs build to match the Makefile (pre-existing griffe warnings); re-add once those are cleaned. ✨ Created with Claude Code
skylarmb
force-pushed
the
ci/properdocs-deploy
branch
from
May 1, 2026 22:57
2258db1 to
770adc0
Compare
skylarmb
enabled auto-merge (squash)
May 1, 2026 22:57
dhruv-hhai
approved these changes
May 1, 2026
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Replace the Sphinx-shaped docs CI with a minimal ProperDocs/MkDocs Pages-deploy workflow that mirrors
make docs-build. The SDK now ships an auto-generated reference site driven bydocs/gen_ref_pages.py+properdocs.yml(landed in v1.0.0rc22, #351), and the existing Sphinx workflows would have failed on first run because their inputs (docs/conf.py, the Divio tutorials/how-to/reference tree) no longer exist.Details
docs-deploy.yml: builds withuv run --extra docs properdocs buildand shipssite/viaactions/upload-pages-artifact@v4+actions/deploy-pages@v4. Triggers on push tofederated-sdk-release-candidatewith path filters coveringsrc/honeyhive/**(docstring changes are doc changes), plusworkflow_dispatchfor manual smoke tests.docs-preview.yml,docs-validation.yml,docs-versioned.yml— all Sphinx-shaped (artifact build of_build/html, live-URL nav check hard-coded to Sphinx pages, mike-based versioning we're not shipping day one).sync-changelog-to-docs.ymluntouched — independent of this Pages site.--strictleft offproperdocs buildto match the Makefile (pre-existing griffe warnings tracked as a follow-up); re-add once those are cleaned.