Publish Sphinx docs via GitHub Actions Pages#535
Merged
Mbompr merged 2 commits intoX-DataInitiative:masterfrom Apr 22, 2026
Merged
Publish Sphinx docs via GitHub Actions Pages#535Mbompr merged 2 commits intoX-DataInitiative:masterfrom
Mbompr merged 2 commits intoX-DataInitiative:masterfrom
Conversation
Adds a docs.yml workflow that builds the Sphinx site on push to master and deploys it through actions/deploy-pages, replacing the dormant gh-pages branch flow (last updated 2017). Also un-ignores .github/ so workflow files stop being swallowed by the blanket .* rule, and reads the doc version/release from the installed tick distribution so they track pyproject.toml automatically. Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
Switch `make html-noplot` to `make html` so the published site executes the example gallery and inline module plots, matching the pre-2017 builds. Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
2 tasks
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
1 participant
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
.github/workflows/docs.ymlthat builds the Sphinx site on every push tomasterand deploys it throughactions/deploy-pages@v5, replacing thegh-pagesbranch flow (last updated 2017-04-25)..github/in.gitignoreso workflow files stop being swallowed by the blanket.*rule (the reasondocs.ymlwas never committed until now).doc/conf.py, readrelease/versionfrom the installedtickdistribution viaimportlib.metadataso they trackpyproject.toml(currently0.8.0.1) instead of the hard-coded0.6.0.One-time settings change required
This PR alone will not make the site update. A repo admin needs to switch Settings → Pages → Source from "Deploy from a branch" to "GitHub Actions". Without that flip, the
deployjob will fail with a Pages-not-enabled error.Once flipped, the stale
gh-pagesbranch can be deleted (or left as a historical artifact).Test plan
buildjob producesdoc/_build/htmlviahtmlon the PR run.https://x-datainitiative.github.io/tick/serves the new build.0.8.0.1rather than0.6.0.🤖 Generated with Claude Code