summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorDong-hee Na <donghee.na@python.org>2022-05-13 00:42:22 +0900
committerGitHub <noreply@github.com>2022-05-12 17:42:22 +0200
commita5ed8947037da5f9d50efd17f70546986dd46c74 (patch)
treefa9cdd8c413f9fc7ee06925799b8688c6c2b34dd
parent10bc004642786662324a2b0fc9a804e1110f582b (diff)
downloadcpython-git-a5ed8947037da5f9d50efd17f70546986dd46c74.tar.gz
[3.8] gh-92448: Update the documentation builder to render the GitHub… (GH-92605)
(cherry picked from commit 45e1721d100bab09510ccf9da49f14ca5cc268f4) Co-authored-by: Dong-hee Na <donghee.na@python.org>
-rw-r--r--Doc/tools/extensions/pyspecific.py9
-rw-r--r--Misc/NEWS.d/3.7.0a3.rst2
-rw-r--r--Misc/NEWS.d/3.8.0.rst2
-rw-r--r--Misc/NEWS.d/3.8.0a1.rst2
-rw-r--r--Misc/NEWS.d/3.8.2rc2.rst2
5 files changed, 9 insertions, 8 deletions
diff --git a/Doc/tools/extensions/pyspecific.py b/Doc/tools/extensions/pyspecific.py
index cd9144ea09..359d764514 100644
--- a/Doc/tools/extensions/pyspecific.py
+++ b/Doc/tools/extensions/pyspecific.py
@@ -390,7 +390,8 @@ class DeprecatedRemoved(Directive):
# Support for including Misc/NEWS
-issue_re = re.compile('(?:[Ii]ssue #|bpo-)([0-9]+)')
+issue_re = re.compile('(?:[Ii]ssue #|bpo-)([0-9]+)', re.I)
+gh_issue_re = re.compile('(?:gh-issue-|gh-)([0-9]+)', re.I)
whatsnew_re = re.compile(r"(?im)^what's new in (.*?)\??$")
@@ -417,9 +418,9 @@ class MiscNews(Directive):
text = 'The NEWS file is not available.'
node = nodes.strong(text, text)
return [node]
- content = issue_re.sub(r'`bpo-\1 <https://bugs.python.org/'
- r'issue?@action=redirect&bpo=\1>`__',
- content)
+ content = issue_re.sub(r':issue:`\1`', content)
+ # Fallback handling for the GitHub issue
+ content = gh_issue_re.sub(r':gh:`\1`', content)
content = whatsnew_re.sub(r'\1', content)
# remove first 3 lines as they are the main heading
lines = ['.. default-role:: obj', ''] + content.splitlines()[3:]
diff --git a/Misc/NEWS.d/3.7.0a3.rst b/Misc/NEWS.d/3.7.0a3.rst
index 8ef7a5118a..3944825e15 100644
--- a/Misc/NEWS.d/3.7.0a3.rst
+++ b/Misc/NEWS.d/3.7.0a3.rst
@@ -288,7 +288,7 @@ by Nir Soffer.
..
-.. bpo: 321010
+.. bpo: 32101
.. date: 2017-11-29-00-42-47
.. nonce: -axD5l
.. section: Library
diff --git a/Misc/NEWS.d/3.8.0.rst b/Misc/NEWS.d/3.8.0.rst
index e72025cfca..8e9ab4097e 100644
--- a/Misc/NEWS.d/3.8.0.rst
+++ b/Misc/NEWS.d/3.8.0.rst
@@ -28,7 +28,7 @@ none were collected.
.. nonce: 9TWMlz
.. section: Library
-Revert GH-15522, which introduces a regression in
+Revert PR 15522, which introduces a regression in
:meth:`mimetypes.guess_type` due to improper handling of filenames as urls.
..
diff --git a/Misc/NEWS.d/3.8.0a1.rst b/Misc/NEWS.d/3.8.0a1.rst
index 873f53b450..da25b1970c 100644
--- a/Misc/NEWS.d/3.8.0a1.rst
+++ b/Misc/NEWS.d/3.8.0a1.rst
@@ -4617,7 +4617,7 @@ Based on patch by c-fos.
.. section: Library
Remove HMAC default to md5 marked for removal in 3.8 (removal originally
-planned in 3.6, bump to 3.8 in gh-7062).
+planned in 3.6, bump to 3.8 in PR 7062).
..
diff --git a/Misc/NEWS.d/3.8.2rc2.rst b/Misc/NEWS.d/3.8.2rc2.rst
index fed6ceadb2..feadb3affc 100644
--- a/Misc/NEWS.d/3.8.2rc2.rst
+++ b/Misc/NEWS.d/3.8.2rc2.rst
@@ -54,7 +54,7 @@ Syntax errors raised in the tokenizer now always set correct "text" and
.. section: Library
The original fix for bpo-27657, "Fix urlparse() with numeric paths"
-(GH-16839) included in 3.8.1, inadvertently introduced a behavior change
+(PR 16839) included in 3.8.1, inadvertently introduced a behavior change
that broke several third-party packages relying on the original undefined
parsing behavior. The change is reverted in 3.8.2, restoring the behavior of
3.8.0 and earlier releases.