diff options
| author | Ned Batchelder <ned@nedbatchelder.com> | 2023-07-10 03:41:31 (GMT) |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2023-07-10 03:41:31 (GMT) |
| commit | dac1e364901d3668742e6eecc2ce63586330c11f (patch) | |
| tree | c13ed9bb48573adc8669d0c00499f3a92b582974 /Doc/tools/extensions | |
| parent | 970982e03d34655df262e14a5efcfdc0bddc0add (diff) | |
| download | cpython-dac1e364901d3668742e6eecc2ce63586330c11f.zip cpython-dac1e364901d3668742e6eecc2ce63586330c11f.tar.gz cpython-dac1e364901d3668742e6eecc2ce63586330c11f.tar.bz2 | |
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.
Diffstat (limited to 'Doc/tools/extensions')
| -rw-r--r-- | Doc/tools/extensions/pyspecific.py | 1 |
1 files changed, 1 insertions, 0 deletions
diff --git a/Doc/tools/extensions/pyspecific.py b/Doc/tools/extensions/pyspecific.py index 795aeed..8d99b0b 100644 --- a/Doc/tools/extensions/pyspecific.py +++ b/Doc/tools/extensions/pyspecific.py @@ -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() |