Integrate sphinx-issues; convert inline PyPI URLs to :pypi:#2076
Integrate sphinx-issues; convert inline PyPI URLs to :pypi:#2076sadiqkhzn wants to merge 1 commit into
Conversation
|
Heads-up for reviewers: I noticed #2041 by @Herrtian also closes #1370 and adds the same one-line extlink alias. I missed it when picking this issue up — apologies. This PR additionally does the inline-link conversions (10 sites across 3 files), with rationale in the description for what was deliberately not converted. I'm happy whichever path the maintainers prefer:
Let me know which works best. |
webknjaz
left a comment
There was a problem hiding this comment.
sphinx-issuesdoes not register apypirole, so it cannot fully cover this case. The pip project went the same route in pypa/pip#12616, keepingpypias a plain extlink alongsidesphinx-issues. This PR follows the same pattern.
That's not true. The plugin defines that role. Integrate it instead, as discussed in the issue.
Additionally, to keep this reviewable, could you delete most of the llm noise in the PR description?
|
You're right, sorry — I was relying on outdated info from an earlier issue comment. Pushed an update that integrates it: One thing to flag: sphinx-issues 5.0.1 (latest compatible with the pinned Sphinx 7.2.6) hardcodes |
Closes #1370.
Integrates sphinx-issues so the
:pypi:role is available, per @webknjaz's feedback. The existingissue/pr/commit/userextlinks are moved over to sphinx-issues as well;ghstays in extlinks since sphinx-issues doesn't provide it.Also converts ten inline
pypi.org/projectURLs in three files to use:pypi:, only in places where the visible link text already matched the project name.One side effect to flag:
:pr:usages innews.rstnow render as(#N)instead of(PR #N). sphinx-issues 5.0.1 restrictsissues_pr_prefixto#,@, or!, so the previous prefix can't be configured. Same end state as pypa/pip#12616. Happy to convert the 109:pr:lines to inline links if you'd rather preserve the prose.