Add custom RST roles extlinks to the docs setup #6045
Merged
Conversation
This file contains 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
This patch declares the following roles within Sphinx:
* issue
* pr
* commit
* gh
* user
They all correspond to respective GitHub URLs. For example,
the following will link a GitHub user page:
:user:`webknjaz`
webknjaz
added
enhancement
documentation
psf-chronographer
bot
added
bot:chronographer:provided
Backport to 3.8: 💚 backport PR created✅ Backport PR branch: Backported as #6046 🤖 @patchback |
patchback bot
pushed a commit
that referenced
this pull request
Oct 5, 2021
This patch declares the following roles within Sphinx:
* issue
* pr
* commit
* gh
* user
They all correspond to respective GitHub URLs. For example,
the following will link a GitHub user page:
:user:`webknjaz`
(cherry picked from commit 13c26be)
5 tasks
webknjaz
added a commit
that referenced
this pull request
Oct 5, 2021
…e docs setup (#6046) This patch declares the following roles within Sphinx: * issue * pr * commit * gh * user They all correspond to respective GitHub URLs. For example, the following will link a GitHub user page: :user:`webknjaz` (cherry picked from commit 13c26be) Co-authored-by: Sviatoslav Sydorenko <[email protected]>
webknjaz
added a commit
to webknjaz/aiohttp
that referenced
this pull request
Oct 5, 2021
webknjaz
added a commit
that referenced
this pull request
Oct 5, 2021
webknjaz
added a commit
that referenced
this pull request
Oct 5, 2021
#6045 (#6053) (cherry picked from commit 1aaac4e) Co-authored-by: Sviatoslav Sydorenko <[email protected]>
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.
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.txtCHANGESfolder<issue_id>.<type>for example (588.bugfix)issue_idchange 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.