Merge pull request #12522 from webknjaz/docs/sphinx-issues-ext

📝 Replace GH/PyPI `extlinks` w/ `sphinx-issues`

changelog/12522.contrib.rst

@@ -0,0 +1,4 @@
+The ``:pull:`` RST role has been replaced with a shorter
+``:pr:`` due to starting to use the implementation from
+the third-party :pypi:`sphinx-issues` Sphinx extension
+-- by :user:`webknjaz`.

doc/en/announce/release-2.9.0.rst

@@ -45,7 +45,7 @@ The py.test Development Team
 **New Features**
 
 * New ``pytest.mark.skip`` mark, which unconditionally skips marked tests.
-  Thanks :user:`MichaelAquilina` for the complete PR (:pull:`1040`).
+  Thanks :user:`MichaelAquilina` for the complete PR (:pr:`1040`).
 
 * ``--doctest-glob`` may now be passed multiple times in the command-line.
   Thanks :user:`jab` and :user:`nicoddemus` for the PR.

doc/en/announce/release-2.9.1.rst

@@ -44,7 +44,7 @@ The py.test Development Team
   Thanks :user:`nicoddemus` for the PR.
 
 * Fix (:issue:`469`): junit parses report.nodeid incorrectly, when params IDs
-  contain ``::``. Thanks :user:`tomviner` for the PR (:pull:`1431`).
+  contain ``::``. Thanks :user:`tomviner` for the PR (:pr:`1431`).
 
 * Fix (:issue:`578`): SyntaxErrors
   containing non-ascii lines at the point of failure generated an internal

doc/en/announce/release-2.9.2.rst

@@ -44,14 +44,14 @@ The py.test Development Team
 
 * Fix Xfail does not work with condition keyword argument.
   Thanks :user:`astraw38` for reporting the issue (:issue:`1496`) and :user:`tomviner`
-  for PR the (:pull:`1524`).
+  for PR the (:pr:`1524`).
 
 * Fix win32 path issue when putting custom config file with absolute path
   in ``pytest.main("-c your_absolute_path")``.
 
 * Fix maximum recursion depth detection when raised error class is not aware
   of unicode/encoded bytes.
-  Thanks :user:`prusse-martin` for the PR (:pull:`1506`).
+  Thanks :user:`prusse-martin` for the PR (:pr:`1506`).
 
 * Fix ``pytest.mark.skip`` mark when used in strict mode.
   Thanks :user:`pquentin` for the PR and :user:`RonnyPfannschmidt` for

doc/en/conf.py

@@ -89,6 +89,7 @@
     "sphinx_removed_in",
     "sphinxcontrib_trio",
     "sphinxcontrib.towncrier.ext",  # provides `towncrier-draft-entries` directive
+    "sphinx_issues",  # implements `:issue:`, `:pr:` and other GH-related roles
 ]
 
 # Building PDF docs on readthedocs requires inkscape for svg to pdf
@@ -170,13 +171,8 @@
 linkcheck_workers = 5
 
 
-_repo = "https://github.com/pytest-dev/pytest"
 extlinks = {
     "bpo": ("https://bugs.python.org/issue%s", "bpo-%s"),
-    "pypi": ("https://pypi.org/project/%s/", "%s"),
-    "issue": (f"{_repo}/issues/%s", "issue #%s"),
-    "pull": (f"{_repo}/pull/%s", "pull request #%s"),
-    "user": ("https://github.com/%s", "@%s"),
 }
 
 
@@ -451,6 +447,11 @@
 towncrier_draft_config_path = "pyproject.toml"  # relative to cwd
 
 
+# -- Options for sphinx_issues extension -----------------------------------
+
+issues_github_path = "pytest-dev/pytest"
+
+
 intersphinx_mapping = {
     "pluggy": ("https://pluggy.readthedocs.io/en/stable", None),
     "python": ("https://docs.python.org/3", None),

doc/en/historical-notes.rst

@@ -107,7 +107,7 @@ Here is a non-exhaustive list of issues fixed by the new implementation:
 
 * Marker transfer incompatible with inheritance (:issue:`535`).
 
-More details can be found in the :pull:`original PR <3317>`.
+More details can be found in the :pr:`original PR <3317>`.
 
 .. note::
 

doc/en/requirements.txt

@@ -10,3 +10,4 @@ sphinxcontrib-svg2pdfconverter
 packaging
 furo
 sphinxcontrib-towncrier
+sphinx-issues