diff options
author | Hugo van Kemenade <1324225+hugovk@users.noreply.github.com> | 2024-04-15 18:22:00 (GMT) |
---|---|---|
committer | GitHub <noreply@github.com> | 2024-04-15 18:22:00 (GMT) |
commit | 3375282bb894347b73c11752f0797d90dadaf465 (patch) | |
tree | 1dfae89f14c8182dfbe053ea39b3b181bcc8c501 /Doc/tools | |
parent | 78da15406705f88ffa79dafac491fb93b373e8e9 (diff) | |
download | cpython-3375282bb894347b73c11752f0797d90dadaf465.zip cpython-3375282bb894347b73c11752f0797d90dadaf465.tar.gz cpython-3375282bb894347b73c11752f0797d90dadaf465.tar.bz2 |
Docs: add link roles with Sphinx extlinks (#117850)
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
Diffstat (limited to 'Doc/tools')
-rw-r--r-- | Doc/tools/extensions/pyspecific.py | 15 |
1 files changed, 2 insertions, 13 deletions
diff --git a/Doc/tools/extensions/pyspecific.py b/Doc/tools/extensions/pyspecific.py index c31d67d..8c88612 100644 --- a/Doc/tools/extensions/pyspecific.py +++ b/Doc/tools/extensions/pyspecific.py @@ -26,7 +26,6 @@ from sphinx.errors import NoUri from sphinx.locale import _ as sphinx_gettext from sphinx.util import logging from sphinx.util.docutils import SphinxDirective -from sphinx.util.nodes import split_explicit_title from sphinx.writers.text import TextWriter, TextTranslator try: @@ -39,6 +38,7 @@ except ImportError: ISSUE_URI = 'https://bugs.python.org/issue?@action=redirect&bpo=%s' GH_ISSUE_URI = 'https://github.com/python/cpython/issues/%s' +# Used in conf.py and updated here by python/release-tools/run_release.py SOURCE_URI = 'https://github.com/python/cpython/tree/main/%s' # monkey-patch reST parser to disable alphabetic and roman enumerated lists @@ -54,6 +54,7 @@ from sphinx.domains import std std.token_re = re.compile(r'`((~?[\w-]*:)?\w+)`') + # Support for marking up and linking to bugs.python.org issues def issue_role(typ, rawtext, text, lineno, inliner, options={}, content=[]): @@ -85,16 +86,6 @@ def gh_issue_role(typ, rawtext, text, lineno, inliner, options={}, content=[]): return [refnode], [] -# Support for linking to Python source files easily - -def source_role(typ, rawtext, text, lineno, inliner, options={}, content=[]): - has_t, title, target = split_explicit_title(text) - title = utils.unescape(title) - target = utils.unescape(target) - refnode = nodes.reference(title, title, refuri=SOURCE_URI % target) - return [refnode], [] - - # Support for marking up implementation details class ImplementationDetail(Directive): @@ -194,7 +185,6 @@ class Availability(SphinxDirective): return platforms - # Support for documenting audit event def audit_events_purge(app, env, docname): @@ -710,7 +700,6 @@ def patch_pairindextypes(app, _env) -> None: def setup(app): app.add_role('issue', issue_role) app.add_role('gh', gh_issue_role) - app.add_role('source', source_role) app.add_directive('impl-detail', ImplementationDetail) app.add_directive('availability', Availability) app.add_directive('audit-event', AuditEvent) |