Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[PR #6045/13c26be8 backport][3.8] Add custom RST roles extlinks to the docs setup #6046

Conversation

patchback[bot]
Copy link
Contributor

@patchback patchback bot commented Oct 5, 2021

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:

  • issue
  • pr
  • commit
  • gh
  • user

They all correspond to respective GitHub URLs. For example,
the following will link a GitHub user page:

    :user:`webknjaz`

(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

  • I think the code is well written
  • Unit tests for the changes exist
  • Documentation reflects the changes
  • If you provide code modification, please add yourself to CONTRIBUTORS.txt
    • The format is <Name> <Surname>.
    • Please keep alphabetical order, the file is sorted by names.
  • Add a new news fragment into the CHANGES folder
    • name it <issue_id>.<type> for example (588.bugfix)
    • if you don't have an issue_id change it to the pr id after creating the pr
    • ensure type is one of the following:
      • .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.
    • Make sure to use full sentences with correct case and punctuation, for example: "Fix issue with non-ascii contents in doctest text files."

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)
@patchback patchback bot requested a review from asvetlov as a code owner October 5, 2021 22:30
@webknjaz webknjaz merged commit dc96d1f into 3.8 Oct 5, 2021
@webknjaz webknjaz deleted the patchback/backports/3.8/13c26be82aa884994b52add6ec7a476b199fe910/pr-6045 branch October 5, 2021 22:31
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