[Python-checkins] Clarify how topics.py gets created. (#106121)

[JelleZijlstra]

https://github.com/python/cpython/commit/dac1e364901d3668742e6eecc2ce63586330c11f
commit: dac1e364901d3668742e6eecc2ce63586330c11f
branch: main
author: Ned Batchelder <ned at nedbatchelder.com>
committer: JelleZijlstra <jelle.zijlstra at gmail.com>
date: 2023-07-09T20:41:31-07:00
summary:

Clarify how topics.py gets created. (#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.

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

diff --git a/Doc/tools/extensions/pyspecific.py b/Doc/tools/extensions/pyspecific.py
index 795aeed1007a7..8d99b0bfa4f38 100644
--- a/Doc/tools/extensions/pyspecific.py
+++ b/Doc/tools/extensions/pyspecific.py
@@ -559,6 +559,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()