Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions pep_sphinx_extensions/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -95,6 +95,7 @@ def setup(app: Sphinx) -> dict[str, bool]:
) # Transform PEP references to links

app.add_post_transform(pep_references.PEPReferenceRoleTitleText)
app.add_post_transform(pep_references.PEPIntersphinxTitleText)

# Register custom directives
app.add_directive("pep-banner", pep_banner_directive.PEPBanner)
Expand Down
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
import re
from pathlib import Path

from docutils import nodes, transforms
Expand Down Expand Up @@ -33,3 +34,25 @@ def apply(self) -> None:
node["reftitle"] += f" § {target_ids[fragment][0].astext()}"
except KeyError:
pass


class PEPIntersphinxTitleText(transforms.Transform):
"""Remove version numbers from intersphinx reference title text.
Intersphinx sets ``reftitle`` to "(in <project> v<version>)" from the
target's inventory. Version changes between builds make otherwise-unchanged
pages appear modified in Read the Docs PR previews.
"""

# Run after Sphinx's ReferencesResolver (priority 10) has resolved
# intersphinx references
default_priority = 740

version_pattern = re.compile(r"^\(in (.+?) v?\d[^\s)]*\)$")

def apply(self) -> None:
for node in self.document.findall(nodes.reference):
if node.get("internal", True):
continue
reftitle = node.get("reftitle", "")
node["reftitle"] = self.version_pattern.sub(r"(in \1)", reftitle)
2 changes: 1 addition & 1 deletion peps/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,7 @@
# Intersphinx configuration (keep this in alphabetical order)
intersphinx_mapping = {
"devguide": ("https://devguide.python.org", None),
"mypy": ("https://mypy.readthedocs.io/en/latest", None),
"mypy": ("https://mypy.readthedocs.io/en/stable", None),
"packaging": ("https://packaging.python.org/en/latest", None),
"py3.11": ("https://docs.python.org/3.11", None),
"py3.12": ("https://docs.python.org/3.12", None),
Expand Down
Loading