]> git.ipfire.org Git - thirdparty/Python/cpython.git/commitdiff
Clarify how topics.py gets created. (#106121)
authorNed Batchelder <ned@nedbatchelder.com>
Mon, 10 Jul 2023 03:41:31 +0000 (20:41 -0700)
committerGitHub <noreply@github.com>
Mon, 10 Jul 2023 03:41:31 +0000 (20:41 -0700)
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.

Doc/tools/extensions/pyspecific.py

index 795aeed1007a79c09ea1c514ae449c486ca9602a..8d99b0bfa4f381fd57bf2b8b85f604366ca23206 100644 (file)
@@ -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()