[PR #6045/13c26be8 backport][3.8] Add custom RST roles extlinks to the docs setup #6046
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.
This is a backport of PR #6045 as merged into master (13c26be).
What do these changes do?
This patch declares the following roles within Sphinx:
They all correspond to respective GitHub URLs. For example,
the following will link a GitHub user page:
(this is useful for crediting people's contributions in the changelog, a trick I've stolen from tox and improved by optionally linking the Sponsors page that is now used by many other projects I maintain and contribute to)
Are there changes in behavior for the user?
Not for the end-users, no.
When the contributors submit changelog fragments, they may optionally add their signatures with this. Or link the PRs and other stuff on GitHub.
Related issue number
N/A
Checklist
CONTRIBUTORS.txt
CHANGES
folder<issue_id>.<type>
for example (588.bugfix)issue_id
change it to the pr id after creating the pr.feature
: Signifying a new feature..bugfix
: Signifying a bug fix..doc
: Signifying a documentation improvement..removal
: Signifying a deprecation or removal of public API..misc
: A ticket has been closed, but it is not of interest to users.