summaryrefslogtreecommitdiffstats
path: root/Doc
diff options
context:
space:
mode:
authorMiss Islington (bot) <31488909+miss-islington@users.noreply.github.com>2023-07-10 03:42:22 (GMT)
committerGitHub <noreply@github.com>2023-07-10 03:42:22 (GMT)
commit0481b805d6631063887fcbcc27684aa8a2576fae (patch)
treee377e650617ae5a41a713ff1a465c7a7f0b0bdb0 /Doc
parent128a962482ff29325e34b1400c87cc70d509e02a (diff)
downloadcpython-0481b805d6631063887fcbcc27684aa8a2576fae.zip
cpython-0481b805d6631063887fcbcc27684aa8a2576fae.tar.gz
cpython-0481b805d6631063887fcbcc27684aa8a2576fae.tar.bz2
[3.12] Clarify how topics.py gets created. (GH-106121) (#106579)
Clarify how topics.py gets created. (GH-106121) When changing docs, it was easy to find text in topics.py, and I wondered whether I was supposed to edit it. Thankfully, the top of the file says it's auto-generated, so I knew I didn't have to edit it. But I didn't know what started the auto-generation process. It's part of the release process, so I'll leave a note here for future editors. (cherry picked from commit dac1e364901d3668742e6eecc2ce63586330c11f) Co-authored-by: Ned Batchelder <ned@nedbatchelder.com>
Diffstat (limited to 'Doc')
-rw-r--r--Doc/tools/extensions/pyspecific.py1
1 files changed, 1 insertions, 0 deletions
diff --git a/Doc/tools/extensions/pyspecific.py b/Doc/tools/extensions/pyspecific.py
index 8a9e2fc..003229d 100644
--- a/Doc/tools/extensions/pyspecific.py
+++ b/Doc/tools/extensions/pyspecific.py
@@ -559,6 +559,7 @@ class PydocTopicsBuilder(Builder):
try:
f.write('# -*- coding: utf-8 -*-\n'.encode('utf-8'))
f.write(('# Autogenerated by Sphinx on %s\n' % asctime()).encode('utf-8'))
+ f.write('# as part of the release process.\n'.encode('utf-8'))
f.write(('topics = ' + pformat(self.topics) + '\n').encode('utf-8'))
finally:
f.close()