docs: switch sphinx-codeautolink to released 0.19.0, drop branch pin - #27
Merged
Conversation
felix-hilden/sphinx-codeautolink#202 (typing.Self return-annotation resolution) merged upstream 2026-07-29 and shipped in the 0.19.0 PyPI release the same day. Verified directly: downloaded and inspected the 0.19.0 wheel, confirmed the same Self-handling code as the branch we'd been pinning to, and rebuilt the docs against it -- chained method calls like Image.Random(...).print() now cross-link correctly using the real release. Pin sphinx-codeautolink>=0.19.0 in pyproject.toml's docs extra (rather than leaving it unpinned) so the fix is guaranteed rather than incidentally whatever resolves, and drop the git+https branch override from docs/requirements.txt entirely. Removes the corresponding tech-debt.md entry about pinning CI to an unmerged branch, and adds a second real-world example (PR #24) of the ci.yml/pyproject.toml drift problem to the micromamba entry.
Up to standards ✅🟢 Issues
|
| Metric | Results |
|---|---|
| Complexity | 0 |
| Duplication | 0 |
NEW Get contextual insights on your PRs based on Codacy's metrics, along with PR and Jira context, without leaving GitHub. Enable AI reviewer
TIP This summary will be updated as you push new changes.
Root cause of rankfilter() missing from the sidebar: image_class.rst's autosummary blocks lost their :toctree: stubs argument in commit 333fff7 (2026-03-23), which silently broke stub-page generation for every Image method, not just rankfilter -- the sidebar (and every per-method doc page) has been effectively empty on the live published site since then. Restored :toctree: stubs to all blocks, fixed the ~rank -> ~rankfilter entry, and added a "Deprecated aliases" section (matching the existing sources.rst convention) so deprecated methods get a findable migration page instead of silently disappearing. Also cuts docs.yml/conf.py over from sphinx_autorun to sphinx_pyrunblock (now published to PyPI as sphinx-pyrunblock 1.0.0), and bumps docs.yml's actions to current majors (checkout, setup-python, upload-artifact, upload-pages-artifact, deploy-pages). Verified with real local builds throughout (250+ Image stub pages now generate; rankfilter's deprecation notice hyperlinks correctly).
…olving docs conflicts # Conflicts: # tech-debt.md
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.
felix-hilden/sphinx-codeautolink#202 (typing.Self return-annotation resolution) merged upstream 2026-07-29 and shipped in the 0.19.0 PyPI release the same day. Verified directly: downloaded and inspected the 0.19.0 wheel, confirmed the same Self-handling code as the branch we'd been pinning to, and rebuilt the docs against it -- chained method calls like Image.Random(...).print() now cross-link correctly using the real release.
Pin sphinx-codeautolink>=0.19.0 in pyproject.toml's docs extra (rather than leaving it unpinned) so the fix is guaranteed rather than incidentally whatever resolves, and drop the git+https branch override from docs/requirements.txt entirely. Removes the corresponding tech-debt.md entry about pinning CI to an unmerged branch, and adds a second real-world example (PR #24) of the ci.yml/pyproject.toml drift problem to the micromamba entry.