Commit f192a55
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -72,8 +72,7 @@ jobs: | |||
| 72 | 72 | - name: 'Build known-good files in nit-picky mode' | |
| 73 | 73 | run: | | |
| 74 | 74 | # Mark files that must pass nit-picky | |
| 75 | - touch Doc/whatsnew/3.12.rst | ||
| 76 | - touch Doc/library/sqlite3.rst | ||
| 75 | + python Doc/tools/touch-clean-files.py | ||
| 77 | 76 | # Build docs with the '-n' (nit-picky) option, convert warnings to errors (-W) | |
| 78 | 77 | make -C Doc/ PYTHON=../python SPHINXOPTS="-q -n -W --keep-going" html 2>&1 | |
| 79 | 78 | ||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -251,7 +251,7 @@ values but should not rebind them): | |||
| 251 | 251 | are printed. | |
| 252 | 252 | ||
| 253 | 253 | .. versionchanged:: 3.4 | |
| 254 | - Following :pep:`442`, objects with a :meth:`__del__` method don't end | ||
| 254 | + Following :pep:`442`, objects with a :meth:`~object.__del__` method don't end | ||
| 255 | 255 | up in :attr:`gc.garbage` anymore. | |
| 256 | 256 | ||
| 257 | 257 | .. data:: callbacks | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -0,0 +1,10 @@ | |||
| 1 | + # These files must pass Sphinx nit-picky mode, as tested on the CI | ||
| 2 | + # via touch-clean-files.py in doc.yml. | ||
| 3 | + # Add blank lines between files and keep them sorted lexicographically | ||
| 4 | + # to help avoid merge conflicts. | ||
| 5 | + | ||
| 6 | + Doc/library/gc.rst | ||
| 7 | + | ||
| 8 | + Doc/library/sqlite3.rst | ||
| 9 | + | ||
| 10 | + Doc/whatsnew/3.12.rst | ||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -0,0 +1,20 @@ | |||
| 1 | + #!/usr/bin/env python3 | ||
| 2 | + """ | ||
| 3 | + Touch files that must pass Sphinx nit-picky mode | ||
| 4 | + so they are rebuilt and we can catch regressions. | ||
| 5 | + """ | ||
| 6 | + | ||
| 7 | + from pathlib import Path | ||
| 8 | + | ||
| 9 | + # Input file has blank line between entries to reduce merge conflicts | ||
| 10 | + with Path("Doc/tools/clean-files.txt").open() as clean_files: | ||
| 11 | + CLEAN = [ | ||
| 12 | + Path(filename.strip()) | ||
| 13 | + for filename in clean_files | ||
| 14 | + if filename.strip() and not filename.startswith("#") | ||
| 15 | + ] | ||
| 16 | + | ||
| 17 | + print("Touching:") | ||
| 18 | + for filename in CLEAN: | ||
| 19 | + print(filename) | ||
| 20 | + filename.touch() | ||
0 commit comments