From: Miss Islington (bot) <31488909+miss-islington@users.noreply.github.com> Date: Tue, 22 Aug 2023 19:23:55 +0000 (-0700) Subject: [3.11] Clarify how topics.py gets created. (GH-106121) (GH-106580) X-Git-Tag: v3.11.5~12 X-Git-Url: http://git.ipfire.org/?a=commitdiff_plain;h=fadf8a032b8b602ed2681aa912ceab01d095fd8f;p=thirdparty%2FPython%2Fcpython.git [3.11] Clarify how topics.py gets created. (GH-106121) (GH-106580) 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 --- diff --git a/Doc/tools/extensions/pyspecific.py b/Doc/tools/extensions/pyspecific.py index d13a9dfd4c8e..31c42e9d9d3a 100644 --- a/Doc/tools/extensions/pyspecific.py +++ b/Doc/tools/extensions/pyspecific.py @@ -562,6 +562,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()