gh-101100: Expand list of clean docs (GH-103135)

Follow on from https://github.com/python/cpython/pull/103116.

Expand list of clean docs files from 3 to 181. These files have no Sphinx warnings, and their presence in this list means that any new warnings introduced will fail the build.

The list was created by subtracting the list of files with warnings from a list of all files.

I tested with all of those, but found that `touch`ing two clean files (https://github.com/python/cpython/blob/main/Doc/includes/wasm-notavail.rst and https://github.com/python/cpython/blob/main/Doc/whatsnew/changelog.rst) caused a cascade effect and resulted in a number of dirty files being rebuilt too, and failing the build. So those two have been omitted.

Automerge-Triggered-By: GH:hugovk

diff --git a/Doc/tools/clean-files.txt b/Doc/tools/clean-files.txt
index a6197998f504fa5d1f61a629002fcb40602a47f4..baef7c2f89588b2673e1cefd5b4d9635d361be01 100644 (file)
--- a/Doc/tools/clean-files.txt
+++ b/Doc/tools/clean-files.txt
@@ -3,8 +3,364 @@
 # Add blank lines between files and keep them sorted lexicographically
 # to help avoid merge conflicts.
 
+Doc/about.rst
+
+Doc/bugs.rst
+
+Doc/c-api/abstract.rst
+
+Doc/c-api/bytearray.rst
+
+Doc/c-api/concrete.rst
+
+Doc/c-api/contextvars.rst
+
+Doc/c-api/coro.rst
+
+Doc/c-api/frame.rst
+
+Doc/c-api/function.rst
+
+Doc/c-api/gen.rst
+
+Doc/c-api/index.rst
+
+Doc/c-api/iter.rst
+
+Doc/c-api/list.rst
+
+Doc/c-api/method.rst
+
+Doc/c-api/number.rst
+
+Doc/c-api/objbuffer.rst
+
+Doc/c-api/objimpl.rst
+
+Doc/c-api/reflection.rst
+
+Doc/c-api/slice.rst
+
+Doc/c-api/utilities.rst
+
+Doc/contents.rst
+
+Doc/copyright.rst
+
+Doc/distributing/index.rst
+
+Doc/extending/building.rst
+
+Doc/extending/index.rst
+
+Doc/extending/windows.rst
+
+Doc/faq/general.rst
+
+Doc/faq/index.rst
+
+Doc/faq/installed.rst
+
+Doc/faq/windows.rst
+
+Doc/howto/annotations.rst
+
+Doc/howto/clinic.rst
+
+Doc/howto/cporting.rst
+
+Doc/howto/index.rst
+
+Doc/howto/ipaddress.rst
+
+Doc/howto/perf_profiling.rst
+
+Doc/howto/pyporting.rst
+
+Doc/howto/sockets.rst
+
+Doc/installing/index.rst
+
+Doc/library/__main__.rst
+
+Doc/library/allos.rst
+
+Doc/library/archiving.rst
+
+Doc/library/array.rst
+
+Doc/library/asyncio-api-index.rst
+
+Doc/library/asyncio-exceptions.rst
+
+Doc/library/asyncio-llapi-index.rst
+
+Doc/library/asyncio-platforms.rst
+
+Doc/library/asyncio-protocol.rst
+
+Doc/library/asyncio-queue.rst
+
+Doc/library/asyncio-runner.rst
+
+Doc/library/asyncio-sync.rst
+
+Doc/library/asyncio.rst
+
+Doc/library/atexit.rst
+
+Doc/library/audit_events.rst
+
+Doc/library/base64.rst
+
+Doc/library/binary.rst
+
+Doc/library/binascii.rst
+
+Doc/library/builtins.rst
+
+Doc/library/cgitb.rst
+
+Doc/library/colorsys.rst
+
+Doc/library/concurrency.rst
+
+Doc/library/contextvars.rst
+
+Doc/library/copyreg.rst
+
+Doc/library/crypt.rst
+
+Doc/library/crypto.rst
+
+Doc/library/curses.panel.rst
+
+Doc/library/custominterp.rst
+
+Doc/library/datatypes.rst
+
+Doc/library/debug.rst
+
+Doc/library/development.rst
+
+Doc/library/dialog.rst
+
+Doc/library/distribution.rst
+
+Doc/library/email.contentmanager.rst
+
+Doc/library/email.examples.rst
+
+Doc/library/email.header.rst
+
+Doc/library/email.iterators.rst
+
+Doc/library/email.rst
+
+Doc/library/email.utils.rst
+
+Doc/library/ensurepip.rst
+
+Doc/library/errno.rst
+
+Doc/library/fileformats.rst
+
+Doc/library/filesys.rst
+
+Doc/library/fnmatch.rst
+
+Doc/library/frameworks.rst
+
+Doc/library/functional.rst
+
 Doc/library/gc.rst
 
+Doc/library/glob.rst
+
+Doc/library/grp.rst
+
+Doc/library/heapq.rst
+
+Doc/library/hmac.rst
+
+Doc/library/html.entities.rst
+
+Doc/library/html.parser.rst
+
+Doc/library/html.rst
+
+Doc/library/http.rst
+
+Doc/library/i18n.rst
+
+Doc/library/imaplib.rst
+
+Doc/library/imghdr.rst
+
+Doc/library/importlib.metadata.rst
+
+Doc/library/index.rst
+
+Doc/library/internet.rst
+
+Doc/library/intro.rst
+
+Doc/library/ipaddress.rst
+
+Doc/library/ipc.rst
+
+Doc/library/itertools.rst
+
+Doc/library/keyword.rst
+
+Doc/library/language.rst
+
+Doc/library/linecache.rst
+
+Doc/library/mailcap.rst
+
+Doc/library/markup.rst
+
+Doc/library/marshal.rst
+
+Doc/library/math.rst
+
+Doc/library/mimetypes.rst
+
+Doc/library/mm.rst
+
+Doc/library/modulefinder.rst
+
+Doc/library/modules.rst
+
+Doc/library/netdata.rst
+
+Doc/library/nis.rst
+
+Doc/library/numeric.rst
+
+Doc/library/pathlib.rst
+
+Doc/library/pdb.rst
+
+Doc/library/persistence.rst
+
+Doc/library/pipes.rst
+
+Doc/library/pwd.rst
+
+Doc/library/python.rst
+
+Doc/library/queue.rst
+
+Doc/library/quopri.rst
+
+Doc/library/runpy.rst
+
+Doc/library/secrets.rst
+
+Doc/library/security_warnings.rst
+
+Doc/library/shlex.rst
+
+Doc/library/sndhdr.rst
+
+Doc/library/spwd.rst
+
 Doc/library/sqlite3.rst
 
+Doc/library/statistics.rst
+
+Doc/library/stringprep.rst
+
+Doc/library/superseded.rst
+
+Doc/library/symtable.rst
+
+Doc/library/tabnanny.rst
+
+Doc/library/text.rst
+
+Doc/library/timeit.rst
+
+Doc/library/tk.rst
+
+Doc/library/tkinter.colorchooser.rst
+
+Doc/library/tkinter.dnd.rst
+
+Doc/library/tkinter.font.rst
+
+Doc/library/tkinter.messagebox.rst
+
+#Doc/library/token.rst
+
+Doc/library/tokenize.rst
+
+Doc/library/tomllib.rst
+
+Doc/library/trace.rst
+
+Doc/library/tracemalloc.rst
+
+Doc/library/types.rst
+
+Doc/library/typing.rst
+
+Doc/library/unicodedata.rst
+
+Doc/library/unix.rst
+
+Doc/library/urllib.robotparser.rst
+
+Doc/library/urllib.rst
+
+Doc/library/uu.rst
+
+Doc/library/venv.rst
+
+Doc/library/warnings.rst
+
+Doc/library/windows.rst
+
+Doc/library/zipapp.rst
+
+Doc/library/zipfile.rst
+
+Doc/library/zipimport.rst
+
+Doc/library/zoneinfo.rst
+
+Doc/reference/executionmodel.rst
+
+Doc/reference/grammar.rst
+
+Doc/reference/index.rst
+
+Doc/reference/introduction.rst
+
+Doc/reference/toplevel_components.rst
+
+Doc/tutorial/appetite.rst
+
+Doc/tutorial/floatingpoint.rst
+
+Doc/tutorial/index.rst
+
+Doc/tutorial/interpreter.rst
+
+Doc/tutorial/stdlib.rst
+
+Doc/tutorial/venv.rst
+
+Doc/tutorial/whatnow.rst
+
+Doc/using/editors.rst
+
+Doc/using/index.rst
+
+Doc/using/mac.rst
+
 Doc/whatsnew/3.12.rst
+
+Doc/whatsnew/index.rst

diff --git a/Doc/tools/touch-clean-files.py b/Doc/tools/touch-clean-files.py
index 07f3e509a09fb5f0aee995371f85d3f90b7cd4b8..9f55e9446ba7931e7e5f08057da00486e980951d 100644 (file)
--- a/Doc/tools/touch-clean-files.py
+++ b/Doc/tools/touch-clean-files.py
@@ -18,3 +18,4 @@ print("Touching:")
 for filename in CLEAN:
     print(filename)
     filename.touch()
+print(f"Touched {len(CLEAN)} files")