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

📝 Replace GH/PyPI extlinks w/ sphinx-issues #12522

Merged
merged 4 commits into from
Jun 23, 2024

Conversation

webknjaz
Copy link
Member

This Sphinx extension implements more generic roles that can also be used
more flexibly. Relying on an external extension allows us to stop
maintaining an in-repo copy of the commonly used behavior.

As a part of the change, the :pull: RST role is being replaced with :pr:.

webknjaz added 2 commits June 22, 2024 21:54
This is a preparatory patch for integrating the third party
`sphinx-issues` extension.
This extension implements more generic roles that can also be used
more flexibly. Relying on an external extension allows to stop
maintaining an in-repo copy of the commonly used behavior.
@webknjaz webknjaz marked this pull request as ready for review June 22, 2024 20:15
@psf-chronographer psf-chronographer bot added the bot:chronographer:provided (automation) changelog entry is part of PR label Jun 22, 2024
Apparently, the extension only supports one of the pre-defined
prefixes.
@@ -170,13 +171,8 @@
linkcheck_workers = 5


_repo = "https://github.com/pytest-dev/pytest"
extlinks = {
"bpo": ("https://bugs.python.org/issue%s", "bpo-%s"),
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Since BPO is shut down, we might want to switch it to point to cpython github now (not necessary for this PR though).

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fair, I wasn't sure. But yeah, could be separate.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done in #12533.

@webknjaz webknjaz merged commit 2371525 into pytest-dev:main Jun 23, 2024
29 checks passed
Copy link

patchback bot commented Jun 23, 2024

Backport to 8.2.x: 💚 backport PR created

✅ Backport PR branch: patchback/backports/8.2.x/237152552e1782bcfcae402e1540f12348ef9f0e/pr-12522

Backported as #12525

🤖 @patchback
I'm built with octomachinery and
my source is open — https://github.com/sanitizers/patchback-github-app.

patchback bot pushed a commit that referenced this pull request Jun 23, 2024
📝 Replace GH/PyPI `extlinks` w/ `sphinx-issues`

(cherry picked from commit 2371525)
webknjaz added a commit that referenced this pull request Jun 23, 2024
…37152552e1782bcfcae402e1540f12348ef9f0e/pr-12522

[PR #12522/23715255 backport][8.2.x] 📝 Replace GH/PyPI `extlinks` w/ `sphinx-issues`
webknjaz added a commit to webknjaz/pytest that referenced this pull request Jun 26, 2024
BPO is in read-only mode and all issues have been migrated to GitHub.
This patch replaces the use of that role with `:issue:`, recently
integrated via pytest-dev#12522. It also disables the built-in `extlinks` Sphinx
extension as it's no longer in use.
webknjaz added a commit to webknjaz/pytest that referenced this pull request Jun 26, 2024
BPO is in read-only mode and all issues have been migrated to GitHub.
This patch replaces the use of that role with `:issue:`, recently
integrated via pytest-dev#12522. It also disables the built-in `extlinks` Sphinx
extension, as it's no longer in use.
Glyphack pushed a commit to Glyphack/pytest that referenced this pull request Jul 30, 2024
Glyphack pushed a commit to Glyphack/pytest that referenced this pull request Jul 30, 2024
BPO is in read-only mode and all issues have been migrated to GitHub.
This patch replaces the use of that role with `:issue:`, recently
integrated via pytest-dev#12522. It also disables the built-in `extlinks` Sphinx
extension, as it's no longer in use.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bot:chronographer:provided (automation) changelog entry is part of PR
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants