cpython/Doc/tools/touch-clean-files.py
Hugo van Kemenade 20c0f196ff
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
2023-03-31 03:48:46 -07:00

21 lines
558 B
Python

#!/usr/bin/env python3
"""
Touch files that must pass Sphinx nit-picky mode
so they are rebuilt and we can catch regressions.
"""
from pathlib import Path
# Input file has blank line between entries to reduce merge conflicts
with Path("Doc/tools/clean-files.txt").open() as clean_files:
CLEAN = [
Path(filename.strip())
for filename in clean_files
if filename.strip() and not filename.startswith("#")
]
print("Touching:")
for filename in CLEAN:
print(filename)
filename.touch()
print(f"Touched {len(CLEAN)} files")