Skip to content

Commit 20c0f19

Browse files
authored
gh-101100: Expand list of clean docs (GH-103135)
Follow on from #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
1 parent 44bd3fe commit 20c0f19

File tree

2 files changed

+357
-0
lines changed

2 files changed

+357
-0
lines changed

Doc/tools/clean-files.txt

Lines changed: 356 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,364 @@
33
# Add blank lines between files and keep them sorted lexicographically
44
# to help avoid merge conflicts.
55

6+
Doc/about.rst
7+
8+
Doc/bugs.rst
9+
10+
Doc/c-api/abstract.rst
11+
12+
Doc/c-api/bytearray.rst
13+
14+
Doc/c-api/concrete.rst
15+
16+
Doc/c-api/contextvars.rst
17+
18+
Doc/c-api/coro.rst
19+
20+
Doc/c-api/frame.rst
21+
22+
Doc/c-api/function.rst
23+
24+
Doc/c-api/gen.rst
25+
26+
Doc/c-api/index.rst
27+
28+
Doc/c-api/iter.rst
29+
30+
Doc/c-api/list.rst
31+
32+
Doc/c-api/method.rst
33+
34+
Doc/c-api/number.rst
35+
36+
Doc/c-api/objbuffer.rst
37+
38+
Doc/c-api/objimpl.rst
39+
40+
Doc/c-api/reflection.rst
41+
42+
Doc/c-api/slice.rst
43+
44+
Doc/c-api/utilities.rst
45+
46+
Doc/contents.rst
47+
48+
Doc/copyright.rst
49+
50+
Doc/distributing/index.rst
51+
52+
Doc/extending/building.rst
53+
54+
Doc/extending/index.rst
55+
56+
Doc/extending/windows.rst
57+
58+
Doc/faq/general.rst
59+
60+
Doc/faq/index.rst
61+
62+
Doc/faq/installed.rst
63+
64+
Doc/faq/windows.rst
65+
66+
Doc/howto/annotations.rst
67+
68+
Doc/howto/clinic.rst
69+
70+
Doc/howto/cporting.rst
71+
72+
Doc/howto/index.rst
73+
74+
Doc/howto/ipaddress.rst
75+
76+
Doc/howto/perf_profiling.rst
77+
78+
Doc/howto/pyporting.rst
79+
80+
Doc/howto/sockets.rst
81+
82+
Doc/installing/index.rst
83+
84+
Doc/library/__main__.rst
85+
86+
Doc/library/allos.rst
87+
88+
Doc/library/archiving.rst
89+
90+
Doc/library/array.rst
91+
92+
Doc/library/asyncio-api-index.rst
93+
94+
Doc/library/asyncio-exceptions.rst
95+
96+
Doc/library/asyncio-llapi-index.rst
97+
98+
Doc/library/asyncio-platforms.rst
99+
100+
Doc/library/asyncio-protocol.rst
101+
102+
Doc/library/asyncio-queue.rst
103+
104+
Doc/library/asyncio-runner.rst
105+
106+
Doc/library/asyncio-sync.rst
107+
108+
Doc/library/asyncio.rst
109+
110+
Doc/library/atexit.rst
111+
112+
Doc/library/audit_events.rst
113+
114+
Doc/library/base64.rst
115+
116+
Doc/library/binary.rst
117+
118+
Doc/library/binascii.rst
119+
120+
Doc/library/builtins.rst
121+
122+
Doc/library/cgitb.rst
123+
124+
Doc/library/colorsys.rst
125+
126+
Doc/library/concurrency.rst
127+
128+
Doc/library/contextvars.rst
129+
130+
Doc/library/copyreg.rst
131+
132+
Doc/library/crypt.rst
133+
134+
Doc/library/crypto.rst
135+
136+
Doc/library/curses.panel.rst
137+
138+
Doc/library/custominterp.rst
139+
140+
Doc/library/datatypes.rst
141+
142+
Doc/library/debug.rst
143+
144+
Doc/library/development.rst
145+
146+
Doc/library/dialog.rst
147+
148+
Doc/library/distribution.rst
149+
150+
Doc/library/email.contentmanager.rst
151+
152+
Doc/library/email.examples.rst
153+
154+
Doc/library/email.header.rst
155+
156+
Doc/library/email.iterators.rst
157+
158+
Doc/library/email.rst
159+
160+
Doc/library/email.utils.rst
161+
162+
Doc/library/ensurepip.rst
163+
164+
Doc/library/errno.rst
165+
166+
Doc/library/fileformats.rst
167+
168+
Doc/library/filesys.rst
169+
170+
Doc/library/fnmatch.rst
171+
172+
Doc/library/frameworks.rst
173+
174+
Doc/library/functional.rst
175+
6176
Doc/library/gc.rst
7177

178+
Doc/library/glob.rst
179+
180+
Doc/library/grp.rst
181+
182+
Doc/library/heapq.rst
183+
184+
Doc/library/hmac.rst
185+
186+
Doc/library/html.entities.rst
187+
188+
Doc/library/html.parser.rst
189+
190+
Doc/library/html.rst
191+
192+
Doc/library/http.rst
193+
194+
Doc/library/i18n.rst
195+
196+
Doc/library/imaplib.rst
197+
198+
Doc/library/imghdr.rst
199+
200+
Doc/library/importlib.metadata.rst
201+
202+
Doc/library/index.rst
203+
204+
Doc/library/internet.rst
205+
206+
Doc/library/intro.rst
207+
208+
Doc/library/ipaddress.rst
209+
210+
Doc/library/ipc.rst
211+
212+
Doc/library/itertools.rst
213+
214+
Doc/library/keyword.rst
215+
216+
Doc/library/language.rst
217+
218+
Doc/library/linecache.rst
219+
220+
Doc/library/mailcap.rst
221+
222+
Doc/library/markup.rst
223+
224+
Doc/library/marshal.rst
225+
226+
Doc/library/math.rst
227+
228+
Doc/library/mimetypes.rst
229+
230+
Doc/library/mm.rst
231+
232+
Doc/library/modulefinder.rst
233+
234+
Doc/library/modules.rst
235+
236+
Doc/library/netdata.rst
237+
238+
Doc/library/nis.rst
239+
240+
Doc/library/numeric.rst
241+
242+
Doc/library/pathlib.rst
243+
244+
Doc/library/pdb.rst
245+
246+
Doc/library/persistence.rst
247+
248+
Doc/library/pipes.rst
249+
250+
Doc/library/pwd.rst
251+
252+
Doc/library/python.rst
253+
254+
Doc/library/queue.rst
255+
256+
Doc/library/quopri.rst
257+
258+
Doc/library/runpy.rst
259+
260+
Doc/library/secrets.rst
261+
262+
Doc/library/security_warnings.rst
263+
264+
Doc/library/shlex.rst
265+
266+
Doc/library/sndhdr.rst
267+
268+
Doc/library/spwd.rst
269+
8270
Doc/library/sqlite3.rst
9271

272+
Doc/library/statistics.rst
273+
274+
Doc/library/stringprep.rst
275+
276+
Doc/library/superseded.rst
277+
278+
Doc/library/symtable.rst
279+
280+
Doc/library/tabnanny.rst
281+
282+
Doc/library/text.rst
283+
284+
Doc/library/timeit.rst
285+
286+
Doc/library/tk.rst
287+
288+
Doc/library/tkinter.colorchooser.rst
289+
290+
Doc/library/tkinter.dnd.rst
291+
292+
Doc/library/tkinter.font.rst
293+
294+
Doc/library/tkinter.messagebox.rst
295+
296+
#Doc/library/token.rst
297+
298+
Doc/library/tokenize.rst
299+
300+
Doc/library/tomllib.rst
301+
302+
Doc/library/trace.rst
303+
304+
Doc/library/tracemalloc.rst
305+
306+
Doc/library/types.rst
307+
308+
Doc/library/typing.rst
309+
310+
Doc/library/unicodedata.rst
311+
312+
Doc/library/unix.rst
313+
314+
Doc/library/urllib.robotparser.rst
315+
316+
Doc/library/urllib.rst
317+
318+
Doc/library/uu.rst
319+
320+
Doc/library/venv.rst
321+
322+
Doc/library/warnings.rst
323+
324+
Doc/library/windows.rst
325+
326+
Doc/library/zipapp.rst
327+
328+
Doc/library/zipfile.rst
329+
330+
Doc/library/zipimport.rst
331+
332+
Doc/library/zoneinfo.rst
333+
334+
Doc/reference/executionmodel.rst
335+
336+
Doc/reference/grammar.rst
337+
338+
Doc/reference/index.rst
339+
340+
Doc/reference/introduction.rst
341+
342+
Doc/reference/toplevel_components.rst
343+
344+
Doc/tutorial/appetite.rst
345+
346+
Doc/tutorial/floatingpoint.rst
347+
348+
Doc/tutorial/index.rst
349+
350+
Doc/tutorial/interpreter.rst
351+
352+
Doc/tutorial/stdlib.rst
353+
354+
Doc/tutorial/venv.rst
355+
356+
Doc/tutorial/whatnow.rst
357+
358+
Doc/using/editors.rst
359+
360+
Doc/using/index.rst
361+
362+
Doc/using/mac.rst
363+
10364
Doc/whatsnew/3.12.rst
365+
366+
Doc/whatsnew/index.rst

Doc/tools/touch-clean-files.py

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,3 +18,4 @@
1818
for filename in CLEAN:
1919
print(filename)
2020
filename.touch()
21+
print(f"Touched {len(CLEAN)} files")

0 commit comments

Comments
 (0)