Skip to content

Commit

Permalink
[3.12] Clarify how topics.py gets created. (GH-106121) (#106579)
Browse files Browse the repository at this point in the history
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 dac1e36)

Co-authored-by: Ned Batchelder <ned@nedbatchelder.com>
  • Loading branch information
miss-islington and nedbat authored Jul 10, 2023
1 parent 128a962 commit 0481b80
Showing 1 changed file with 1 addition and 0 deletions.
1 change: 1 addition & 0 deletions Doc/tools/extensions/pyspecific.py
Original file line number Diff line number Diff line change
Expand Up @@ -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()
Expand Down

0 comments on commit 0481b80

Please sign in to comment.