Skip to content

[Docs] Fix incorrectly displayed links in CHANGELOG#3124

Merged
abravalheri merged 5 commits into
pypa:mainfrom
abravalheri:fix-docs
Feb 19, 2022
Merged

[Docs] Fix incorrectly displayed links in CHANGELOG#3124
abravalheri merged 5 commits into
pypa:mainfrom
abravalheri:fix-docs

Conversation

@abravalheri

@abravalheri abravalheri commented Feb 19, 2022

Copy link
Copy Markdown
Contributor

Motivation

Currently, there are a series of links being incorrectly displayed in the CHANGELOG, for example:

image

image

image

image

Summary of changes

  • Improve regex in docs/conf.py to avoid accidentally matching #<issue-number> or PEP mentions.
  • Extend matching of pypa/<repo>#<issue> and pypa/<repo>@<commit> to any PyPA repository (currently only distutils is supported).
  • Manually convert some entries to make use of the improvements above.

Pull Request Checklist

Use negative look-behind regex on docs/conf.py to improve `issues` URL
matching.
Currently the link for the pypa/get-pip issue was rendering wrongly.
This change extends the matching for issues and commits (currently only
handling `distutils`) to any PyPA repository.
@abravalheri abravalheri marked this pull request as ready for review February 19, 2022 13:06
@abravalheri abravalheri merged commit 6a2f486 into pypa:main Feb 19, 2022
@abravalheri abravalheri deleted the fix-docs branch February 19, 2022 19:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant