[Python-checkins] [3.11] Clarify how topics.py gets created. (GH-106121) (GH-106580)

[serhiy-storchaka]

https://github.com/python/cpython/commit/fadf8a032b8b602ed2681aa912ceab01d095fd8f
commit: fadf8a032b8b602ed2681aa912ceab01d095fd8f
branch: 3.11
author: Miss Islington (bot) <31488909+miss-islington at users.noreply.github.com>
committer: serhiy-storchaka <storchaka at gmail.com>
date: 2023-08-22T19:23:55Z
summary:

[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 <ned at nedbatchelder.com>

files:
M Doc/tools/extensions/pyspecific.py

diff --git a/Doc/tools/extensions/pyspecific.py b/Doc/tools/extensions/pyspecific.py
index d13a9dfd4c8eb..31c42e9d9d3a6 100644
--- a/Doc/tools/extensions/pyspecific.py
+++ b/Doc/tools/extensions/pyspecific.py
@@ -562,6 +562,7 @@ def finish(self):
         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()