Conversation
The Sphinx docs under docs/ were never regenerated automatically; they are a static 2017 snapshot served by GitHub Pages. Add a docs workflow that rebuilds the docs from docstrings (sphinx autodoc) and deploys them to Pages on release publication (mirroring the PyPI publish trigger), so the published docs track each release. Also supports manual dispatch. Adds requirements-docs.txt pinning the doc toolchain (sphinx, sphinx_rtd_theme, sphinx-copybutton). NOTE: requires the repo's Pages source to be set to "GitHub Actions" (Settings -> Pages) instead of "Deploy from a branch", since this uses actions/deploy-pages. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
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
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.
Problem
The Sphinx docs under
docs/are not regenerated automatically — there's no docs workflow, and GitHub Pages just serves the committed HTML. That HTML is a static 2017 snapshot (last built ind11dd4c), so the published docs are missing years of features (.modmodel reading, thefile_typeparam, pickle support, etc.). They don't reflect current docstrings.Fix
Add a
docsworkflow that rebuilds the docs from docstrings (sphinx.ext.autodoc) and deploys to GitHub Pages on release publication — the same trigger as the existing PyPI publish workflow — so the docs track each released version rather than churning on every push. Manualworkflow_dispatchis also supported for an on-demand rebuild.requirements-docs.txtpins the doc toolchain (sphinx,sphinx_rtd_theme,sphinx-copybutton).sphinx-build -b html docs_source _site) was verified locally — builds cleanly and reflects current docstrings.This uses
actions/deploy-pages, so the repo's Pages source must be switched from "Deploy from a branch" (/docs) to "GitHub Actions" under Settings → Pages. Until that's flipped, thedeployjob will fail. (I can do this viagh apiif you'd like — just say so.)Follow-ups (not in this PR)
docs/HTML becomes vestigial and could be removed from the repo.version/releaseindocs_source/conf.py(3.5.0) is stale vssetup.py(0.3.5) and could be wired to the package version.🤖 Generated with Claude Code