forked from sphinx-doc/sphinx
-
Notifications
You must be signed in to change notification settings - Fork 0
/
.ruff.toml
704 lines (688 loc) · 32.9 KB
/
.ruff.toml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
target-version = "py39" # Pin Ruff to Python 3.9
line-length = 95
output-format = "full"
[lint]
preview = true
exclude = [
".git",
".tox",
".venv",
"tests/roots/*",
"build/*",
"doc/_build/*",
"sphinx/search/*",
"doc/usage/extensions/example*.py",
]
ignore = [
"ANN401", # Dynamically typed expressions (typing.Any) are disallowed in `{name}`
"E741", # Ambiguous variable name: `{name}`
"F841", # Local variable `{name}` is assigned to but never used
"FURB101", # `open` and `read` should be replaced by `Path(...).read_text(...)`
"PLC1901", # simplify truthy/falsey string comparisons
"SIM102", # Use a single `if` statement instead of nested `if` statements
"SIM108", # Use ternary operator `{contents}` instead of `if`-`else`-block
"UP031", # Use format specifiers instead of percent format
"UP032", # Use f-string instead of `format` call
]
external = [ # Whitelist for RUF100 unknown code warnings
"E704",
"SIM113",
]
select = [
# flake8-builtins ('A')
# NOT YET USED
# airflow ('AIR')
# Airflow is not used in Sphinx
"ANN", # flake8-annotations ('ANN')
# flake8-unused-arguments ('ARG')
"ARG004", # Unused static method argument: `{name}`
# flake8-async ('ASYNC')
"ASYNC",
# flake8-bugbear ('B')
"B",
# flake8-blind-except ('BLE')
# NOT YET USED
# flake8-comprehensions ('C4')
"C4",
# mccabe ('C90')
# "C901", # `{name}` is too complex ({complexity} > {max_complexity})
# flake8-commas ('COM')
"COM818", # Trailing comma on bare tuple prohibited
"COM819", # Trailing comma prohibited
# flake8-copyright ('CPY')
# NOT YET USED
# pydocstyle ('D')
# "D100", # Missing docstring in public module
# "D101", # Missing docstring in public class
# "D102", # Missing docstring in public method
# "D103", # Missing docstring in public function
# "D104", # Missing docstring in public package
# "D105", # Missing docstring in magic method
"D106", # Missing docstring in public nested class
# "D107", # Missing docstring in `__init__`
# "D200", # One-line docstring should fit on one line
"D201", # No blank lines allowed before function docstring (found {num_lines})
"D202", # No blank lines allowed after function docstring (found {num_lines})
"D204", # 1 blank line required after class docstring
# "D205", # 1 blank line required between summary line and description
"D206", # Docstring should be indented with spaces, not tabs
"D207", # Docstring is under-indented
"D208", # Docstring is over-indented
"D209", # Multi-line docstring closing quotes should be on a separate line
"D210", # No whitespaces allowed surrounding docstring text
"D211", # No blank lines allowed before class docstring
# "D212", # Multi-line docstring summary should start at the first line
# "D213", # Multi-line docstring summary should start at the second line
# "D214", # Section is over-indented ("{name}")
# "D215", # Section underline is over-indented ("{name}")
"D300", # Use triple double quotes `"""`
"D301", # Use `r"""` if any backslashes in a docstring
# "D400", # First line should end with a period
# "D401", # First line of docstring should be in imperative mood: "{first_line}"
"D402", # First line should not be the function's signature
"D403", # First word of the first line should be capitalized: `{}` -> `{}`
# "D404", # First word of the docstring should not be "This"
"D405", # Section name should be properly capitalized ("{name}")
# "D406", # Section name should end with a newline ("{name}")
# "D407", # Missing dashed underline after section ("{name}")
"D408", # Section underline should be in the line following the section's name ("{name}")
"D409", # Section underline should match the length of its name ("{name}")
"D410", # Missing blank line after section ("{name}")
"D411", # Missing blank line before section ("{name}")
# "D412", # No blank lines allowed between a section header and its content ("{name}")
# "D413", # Missing blank line after last section ("{name}")
"D414", # Section has no content ("{name}")
# "D415", # First line should end with a period, question mark, or exclamation point
"D416", # Section name should end with a colon ("{name}")
"D417", # Missing argument description in the docstring for `{definition}`: `{name}`
"D418", # Function decorated with `@overload` shouldn't contain a docstring
"D419", # Docstring is empty
# flake8-django ('DJ')
# Django is not used in Sphinx
# flake8-datetimez ('DTZ')
"DTZ",
# pycodestyle ('E')
"E",
# flake8-errmsg ('EM')
"EM101", # Exception must not use a string literal, assign to variable first
"EM102", # Exception must not use an f-string literal, assign to variable first
"EM103", # Exception must not use a `.format()` string directly, assign to variable first
# eradicate ('ERA')
# NOT YET USED
# flake8-executable ('EXE')
"EXE",
# pyflakes ('F')
"F",
# flake8-future-annotations ('FA')
"FA",
# flake8-boolean-trap ('FBT')
# NOT YET USED
# flake8-fixme ('FIX')
# NOT YET USED
# flynt ('FLY')
# NOT YET USED
"FURB", # refurb
# flake8-logging-format ('G')
"G001", # Logging statement uses `str.format`
# "G002", # Logging statement uses `%`
# "G003", # Logging statement uses `+`
"G004", # Logging statement uses f-string
"G010", # Logging statement uses `warn` instead of `warning`
"G101", # Logging statement uses an `extra` field that clashes with a `LogRecord` field: `{key}`
"G201", # Logging `.exception(...)` should be used instead of `.error(..., exc_info=True)`
"G202", # Logging statement has redundant `exc_info`
# isort ('I')
"I",
"ICN", # flake8-import-conventions
# flake8-no-pep420 ('INP')
"INP",
# flake8-gettext ('INT')
"INT001", # f-string is resolved before function call; consider `_("string %s") % arg`
"INT002", # `format` method argument is resolved before function call; consider `_("string %s") % arg`
"INT003", # printf-style format is resolved before function call; consider `_("string %s") % arg`
# flake8-implicit-str-concat ('ISC')
# NOT YET USED
# flake8-logging ('LOG')
"LOG001", # Use `logging.getLogger()` to instantiate loggers
"LOG002", # Use `__name__` with `logging.getLogger()`
"LOG007", # Use of `logging.exception` with falsy `exc_info`
"LOG009", # Use of undocumented `logging.WARN` constant
# pep8-naming ('N')
# NOT YET USED
# numpy-specific rules ('NPY')
# Numpy is not used in Sphinx
# pandas-vet ('PD')
# Pandas is not used in Sphinx
# perflint ('PERF')
"PERF101", # Do not cast an iterable to `list` before iterating over it
"PERF102", # When using only the {subset} of a dict use the `{subset}()` method
# "PERF203", # `try`-`except` within a loop incurs performance overhead
"PERF401", # Use a list comprehension to create a transformed list
"PERF402", # Use `list` or `list.copy` to create a copy of a list
"PERF403", # Use a dictionary comprehension instead of a for-loop
# pygrep-hooks ('PGH')
"PGH",
# flake8-pie ('PIE')
# "PIE790", # Unnecessary `pass` statement
"PIE794", # Class field `{name}` is defined multiple times
"PIE796", # Enum contains duplicate value: `{value}`
"PIE800", # Unnecessary spread `**`
"PIE804", # Unnecessary `dict` kwargs
"PIE807", # Prefer `list` over useless lambda
"PIE810", # Call `{attr}` once with a `tuple`
# pylint ('PLC')
"PLC0105", # `{kind}` name "{param_name}" does not reflect its {variance}; consider renaming it to "{replacement_name}"
"PLC0131", # `{kind}` cannot be both covariant and contravariant
"PLC0132", # `{kind}` name `{param_name}` does not match assigned variable name `{var_name}`
# "PLC0205", # Class `__slots__` should be a non-string iterable
# "PLC0208", # Use a sequence type instead of a `set` when iterating over values
"PLC0414", # Import alias does not rename original package
"PLC3002", # Lambda expression called directly. Execute the expression inline instead.
# pylint ('PLE')
"PLE0100", # `__init__` method is a generator
"PLE0101", # Explicit return in `__init__`
"PLE0116", # `continue` not supported inside `finally` clause
"PLE0117", # Nonlocal name `{name}` found without binding
"PLE0118", # Name `{name}` is used prior to global declaration on line {line}
"PLE0241", # Duplicate base `{base}` for class `{class}`
"PLE0302", # The special method `{}` expects {}, {} {} given
"PLE0307", # `__str__` does not return `str`
"PLE0604", # Invalid object in `__all__`, must contain only strings
"PLE0605", # Invalid format for `__all__`, must be `tuple` or `list`
"PLE1142", # `await` should be used within an async function
"PLE1205", # Too many arguments for `logging` format string
"PLE1206", # Not enough arguments for `logging` format string
"PLE1300", # Unsupported format character '{}'
"PLE1307", # Format type does not match argument type
"PLE1310", # String `{strip}` call contains duplicate characters (did you mean `{removal}`?)
"PLE1507", # Invalid type for initial `os.getenv` argument; expected `str`
"PLE1700", # `yield from` statement in async function; use `async for` instead
"PLE2502", # Contains control characters that can permit obfuscated code
"PLE2510", # Invalid unescaped character backspace, use "\b" instead
"PLE2512", # Invalid unescaped character SUB, use "\x1A" instead
"PLE2513", # Invalid unescaped character ESC, use "\x1B" instead
"PLE2514", # Invalid unescaped character NUL, use "\0" instead
"PLE2515", # Invalid unescaped character zero-width-space, use "\u200B" instead
# pylint ('PLR')
# "PLR0124", # Name compared with itself, consider replacing `{left} {} {right}`
"PLR0133", # Two constants compared in a comparison, consider replacing `{left_constant} {} {right_constant}`
"PLR0206", # Cannot have defined parameters for properties
"PLR0402", # Use `from {module} import {name}` in lieu of alias
# "PLR0911", # Too many return statements ({returns} > {max_returns})
# "PLR0912", # Too many branches ({branches} > {max_branches})
# "PLR0913", # Too many arguments to function call ({c_args} > {max_args})
# "PLR0915", # Too many statements ({statements} > {max_statements})
"PLR1701", # Merge `isinstance` calls: `{expr}`
"PLR1711", # Useless `return` statement at end of function
# "PLR1714", # Consider merging multiple comparisons: `{expr}`. Use a `set` if the elements are hashable.
"PLR1722", # Use `sys.exit()` instead of `{name}`
# "PLR2004", # Magic value used in comparison, consider replacing {value} with a constant variable
# "PLR5501", # Use `elif` instead of `else` then `if`, to reduce indentation
# pylint ('PLW')
"PLW0120", # `else` clause on loop without a `break` statement; remove the `else` and de-indent all the code inside it
"PLW0127", # Self-assignment of variable `{name}`
"PLW0129", # Asserting on an empty string literal will never pass
"PLW0131", # Named expression used without context
"PLW0406", # Module `{name}` imports itself
"PLW0602", # Using global for `{name}` but no assignment is done
# "PLW0603", # Using the global statement to update `{name}` is discouraged
"PLW0711", # Exception to catch is the result of a binary `and` operation
"PLW1508", # Invalid type for environment variable default; expected `str` or `None`
"PLW1509", # `preexec_fn` argument is unsafe when using threads
# "PLW2901", # Outer {outer_kind} variable `{name}` overwritten by inner {inner_kind} target
"PLW3301", # Nested `{}` calls can be flattened
# flake8-pytest-style ('PT')
"PT",
# flake8-use-pathlib ('PTH')
# NOT YET USED
# flake8-pyi ('PYI')
# NOT YET USED
# flake8-quotes ('Q')
# "Q000", # Double quotes found but single quotes preferred
# "Q001", # Single quote multiline found but double quotes preferred
"Q002", # Single quote docstring found but double quotes preferred
"Q003", # Change outer quotes to avoid escaping inner quotes
"Q004", # Unnecessary escape on inner quote character
# flake8-return ('RET')
"RET501", # Do not explicitly `return None` in function if it is the only possible return value
"RET502", # Do not implicitly `return None` in function able to return non-`None` value
# "RET503", # Missing explicit `return` at the end of function able to return non-`None` value
# "RET504", # Unnecessary assignment to `{name}` before `return` statement
# "RET505", # Unnecessary `{branch}` after `return` statement
# "RET506", # Unnecessary `{branch}` after `raise` statement
"RET507", # Unnecessary `{branch}` after `continue` statement
"RET508", # Unnecessary `{branch}` after `break` statement
# flake8-raise ('RSE')
"RSE102", # Unnecessary parentheses on raised exception
# ruff-specific rules ('RUF')
# "RUF001", # String contains ambiguous {}. Did you mean {}?
"RUF002", # Docstring contains ambiguous {}. Did you mean {}?
# "RUF003", # Comment contains ambiguous {}. Did you mean {}?
"RUF005", # Consider `{expression}` instead of concatenation
"RUF006", # Store a reference to the return value of `asyncio.{method}`
"RUF007", # Prefer `itertools.pairwise()` over `zip()` when iterating over successive pairs
"RUF008", # Do not use mutable default values for dataclass attributes
"RUF009", # Do not perform function call `{name}` in dataclass defaults
"RUF010", # Use explicit conversion flag
# "RUF012", # Mutable class attributes should be annotated with `typing.ClassVar`
"RUF013", # PEP 484 prohibits implicit `Optional`
# "RUF015", # Prefer `next({iterable})` over single element slice
"RUF016", # Slice in indexed access to type `{value_type}` uses type `{index_type}` instead of an integer
"RUF017", # Avoid quadratic list summation
"RUF018", # Avoid assignment expressions in `assert` statements
"RUF019", # Unnecessary key check before dictionary access
"RUF020", # `{never_like} | T` is equivalent to `T`
# "RUF100", # Unused `noqa` directive
"RUF200", # Failed to parse pyproject.toml: {message}
# flake8-bandit ('S')
# "S101", # Use of `assert` detected
"S102", # Use of `exec` detected
"S103", # `os.chmod` setting a permissive mask `{mask:#o}` on file or directory
"S104", # Possible binding to all interfaces
# "S105", # Possible hardcoded password assigned to: "{}"
"S106", # Possible hardcoded password assigned to argument: "{}"
"S107", # Possible hardcoded password assigned to function default: "{}"
"S108", # Probable insecure usage of temporary file or directory: "{}"
# "S110", # `try`-`except`-`pass` detected, consider logging the exception
"S112", # `try`-`except`-`continue` detected, consider logging the exception
# "S113", # Probable use of requests call without timeout
# "S301", # `pickle` and modules that wrap it can be unsafe when used to deserialize untrusted data, possible security issue
"S302", # Deserialization with the `marshal` module is possibly dangerous
"S303", # Use of insecure MD2, MD4, MD5, or SHA1 hash function
"S304", # Use of insecure cipher, replace with a known secure cipher such as AES
"S305", # Use of insecure cipher mode, replace with a known secure cipher such as AES
"S306", # Use of insecure and deprecated function (`mktemp`)
"S307", # Use of possibly insecure function; consider using `ast.literal_eval`
"S308", # Use of `mark_safe` may expose cross-site scripting vulnerabilities
"S310", # Audit URL open for permitted schemes. Allowing use of `file:` or custom schemes is often unexpected.
"S311", # Standard pseudo-random generators are not suitable for cryptographic purposes
"S312", # Telnet-related functions are being called. Telnet is considered insecure. Use SSH or some other encrypted protocol.
"S313", # Using `xml` to parse untrusted data is known to be vulnerable to XML attacks; use `defusedxml` equivalents
"S314", # Using `xml` to parse untrusted data is known to be vulnerable to XML attacks; use `defusedxml` equivalents
"S315", # Using `xml` to parse untrusted data is known to be vulnerable to XML attacks; use `defusedxml` equivalents
"S316", # Using `xml` to parse untrusted data is known to be vulnerable to XML attacks; use `defusedxml` equivalents
"S317", # Using `xml` to parse untrusted data is known to be vulnerable to XML attacks; use `defusedxml` equivalents
"S318", # Using `xml` to parse untrusted data is known to be vulnerable to XML attacks; use `defusedxml` equivalents
"S319", # Using `xml` to parse untrusted data is known to be vulnerable to XML attacks; use `defusedxml` equivalents
"S320", # Using `lxml` to parse untrusted data is known to be vulnerable to XML attacks
"S321", # FTP-related functions are being called. FTP is considered insecure. Use SSH/SFTP/SCP or some other encrypted protocol.
"S323", # Python allows using an insecure context via the `_create_unverified_context` that reverts to the previous behavior that does not validate certificates or perform hostname checks.
# "S324", # Probable use of insecure hash functions in `hashlib`: `{string}`
"S501", # Probable use of `{string}` call with `verify=False` disabling SSL certificate checks
"S506", # Probable use of unsafe loader `{name}` with `yaml.load`. Allows instantiation of arbitrary objects. Consider `yaml.safe_load`.
"S508", # The use of SNMPv1 and SNMPv2 is insecure. Use SNMPv3 if able.
"S509", # You should not use SNMPv3 without encryption. `noAuthNoPriv` & `authNoPriv` is insecure.
"S601", # Possible shell injection via Paramiko call; check inputs are properly sanitized
"S602", # `subprocess` call with `shell=True` seems safe, but may be changed in the future; consider rewriting without `shell`
# "S603", # `subprocess` call: check for execution of untrusted input
"S604", # Function call with `shell=True` parameter identified, security issue
"S605", # Starting a process with a shell: seems safe, but may be changed in the future; consider rewriting without `shell`
"S606", # Starting a process without a shell
# "S607", # Starting a process with a partial executable path
"S608", # Possible SQL injection vector through string-based query construction
"S609", # Possible wildcard injection in call due to `*` usage
"S612", # Use of insecure `logging.config.listen` detected
# "S701", # Using jinja2 templates with `autoescape=False` is dangerous and can lead to XSS. Ensure `autoescape=True` or use the `select_autoescape` function.
# "S702", # Mako templates allow HTML and JavaScript rendering by default and are inherently open to XSS attacks
"SIM", # flake8-simplify
# flake8-self ('SLF')
# NOT YET USED
"SLOT", # flake8-slots
# flake8-debugger ('T10')
"T100", # Trace found: `{name}` used
# flake8-print ('T20')
"T201", # `print` found
"T203", # `pprint` found
"TCH", # flake8-type-checking
# flake8-todos ('TD')
# "TD001", # Invalid TODO tag: `{tag}`
# "TD003", # Missing issue link on the line following this TODO
# "TD004", # Missing colon in TODO
# "TD005", # Missing issue description after `TODO`
"TD006", # Invalid TODO capitalization: `{tag}` should be `TODO`
"TD007", # Missing space after colon in TODO
# flake8-tidy-imports ('TID')
"TID251", # `{name}` is banned: {message}
"TID252", # Relative imports from parent modules are banned
"TID253", # `{name}` is banned at the module level
# flake8-trio ('TRIO')
# Trio is not used in Sphinx
# tryceratops ('TRY')
# NOT YET USED
"UP001", # pyupgrade
# pycodestyle ('W')
"W191", # Indentation contains tabs
# "W291", # Trailing whitespace
"W292", # No newline at end of file
"W293", # Blank line contains whitespace
"W505", # Doc line too long ({width} > {limit} characters)
"W605", # Invalid escape sequence: `\{char}`
# flake8-2020 ('YTT')
"YTT",
]
[lint.per-file-ignores]
"doc/*" = [
"ANN", # documentation doesn't need annotations
]
"doc/conf.py" = ["INP001", "W605"]
"doc/development/tutorials/examples/*" = ["INP001"]
# allow print() in the tutorial
"doc/development/tutorials/examples/recipe.py" = ["T201"]
"sphinx/domains/**" = ["FURB113"]
"tests/test_domains/test_domain_cpp.py" = ["FURB113"]
# from .flake8
"sphinx/*" = ["E241"]
# whitelist ``print`` for stdout messages
"sphinx/cmd/build.py" = ["T201"]
"sphinx/cmd/make_mode.py" = ["T201"]
"sphinx/cmd/quickstart.py" = ["T201"]
"sphinx/environment/collectors/toctree.py" = ["B026"]
"sphinx/environment/adapters/toctree.py" = ["B026"]
# whitelist ``print`` for stdout messages
"sphinx/ext/intersphinx.py" = ["T201"]
# whitelist ``print`` for stdout messages
"sphinx/testing/fixtures.py" = ["T201"]
# Ruff bug: https://github.com/astral-sh/ruff/issues/6540
"sphinx/transforms/i18n.py" = ["PGH004"]
# Function wrappers
"sphinx/ext/autodoc/importer.py" = ["D402"]
"sphinx/util/requests.py" = ["D402"]
"tests/*" = [
"E501",
"ANN", # tests don't need annotations
"D402",
"T201", # whitelist ``print`` for tests
]
# these tests need old ``typing`` generic aliases
"tests/test_util/test_util_typing.py" = ["UP006", "UP035"]
"tests/test_util/typing_test_data.py" = ["FA100", "UP006", "UP035"]
"utils/*" = [
"T201", # whitelist ``print`` for stdout messages
"ANN", # utilities don't need annotations
]
[lint.flake8-quotes]
inline-quotes = "single"
[lint.isort]
forced-separate = [
"tests",
]
[format]
preview = true
quote-style = "single"
exclude = [
"sphinx/addnodes.py",
"sphinx/application.py",
"sphinx/builders/gettext.py",
"sphinx/builders/text.py",
"sphinx/builders/linkcheck.py",
"sphinx/builders/_epub_base.py",
"sphinx/builders/dummy.py",
"sphinx/builders/changes.py",
"sphinx/builders/texinfo.py",
"sphinx/builders/dirhtml.py",
"sphinx/builders/__init__.py",
"sphinx/builders/xml.py",
"sphinx/builders/singlehtml.py",
"sphinx/builders/epub3.py",
"sphinx/builders/manpage.py",
"sphinx/builders/latex/constants.py",
"sphinx/builders/latex/__init__.py",
"sphinx/builders/latex/theming.py",
"sphinx/builders/latex/transforms.py",
"sphinx/builders/latex/util.py",
"sphinx/builders/latex/nodes.py",
"sphinx/builders/html/_assets.py",
"sphinx/builders/html/__init__.py",
"sphinx/builders/html/transforms.py",
"sphinx/cmd/quickstart.py",
"sphinx/cmd/build.py",
"sphinx/cmd/make_mode.py",
"sphinx/config.py",
"sphinx/directives/__init__.py",
"sphinx/directives/code.py",
"sphinx/directives/patches.py",
"sphinx/directives/other.py",
"sphinx/domains/math.py",
"sphinx/domains/changeset.py",
"sphinx/domains/javascript.py",
"sphinx/domains/__init__.py",
"sphinx/domains/citation.py",
"sphinx/domains/rst.py",
"sphinx/domains/index.py",
"sphinx/domains/std/__init__.py",
"sphinx/domains/python/_annotations.py",
"sphinx/domains/python/__init__.py",
"sphinx/domains/python/_object.py",
"sphinx/domains/cpp/_parser.py",
"sphinx/domains/cpp/_ids.py",
"sphinx/domains/cpp/__init__.py",
"sphinx/domains/cpp/_symbol.py",
"sphinx/domains/cpp/_ast.py",
"sphinx/domains/c/_parser.py",
"sphinx/domains/c/_ids.py",
"sphinx/domains/c/__init__.py",
"sphinx/domains/c/_symbol.py",
"sphinx/domains/c/_ast.py",
"sphinx/environment/__init__.py",
"sphinx/environment/collectors/dependencies.py",
"sphinx/environment/collectors/toctree.py",
"sphinx/environment/collectors/metadata.py",
"sphinx/environment/collectors/title.py",
"sphinx/environment/collectors/asset.py",
"sphinx/environment/collectors/__init__.py",
"sphinx/environment/adapters/toctree.py",
"sphinx/environment/adapters/indexentries.py",
"sphinx/environment/adapters/asset.py",
"sphinx/ext/extlinks.py",
"sphinx/ext/todo.py",
"sphinx/ext/mathjax.py",
"sphinx/ext/doctest.py",
"sphinx/ext/autosectionlabel.py",
"sphinx/ext/intersphinx.py",
"sphinx/ext/duration.py",
"sphinx/ext/imgconverter.py",
"sphinx/ext/imgmath.py",
"sphinx/ext/apidoc.py",
"sphinx/ext/viewcode.py",
"sphinx/ext/githubpages.py",
"sphinx/ext/linkcode.py",
"sphinx/ext/ifconfig.py",
"sphinx/ext/inheritance_diagram.py",
"sphinx/ext/coverage.py",
"sphinx/ext/graphviz.py",
"sphinx/ext/napoleon/docstring.py",
"sphinx/ext/napoleon/__init__.py",
"sphinx/ext/autodoc/typehints.py",
"sphinx/ext/autodoc/preserve_defaults.py",
"sphinx/ext/autodoc/__init__.py",
"sphinx/ext/autodoc/directive.py",
"sphinx/ext/autodoc/importer.py",
"sphinx/ext/autodoc/type_comment.py",
"sphinx/ext/autodoc/mock.py",
"sphinx/ext/autosummary/__init__.py",
"sphinx/ext/autosummary/generate.py",
"sphinx/pycode/ast.py",
"sphinx/pycode/__init__.py",
"sphinx/pycode/parser.py",
"sphinx/pygments_styles.py",
"sphinx/registry.py",
"sphinx/search/*.py",
"sphinx/testing/fixtures.py",
"sphinx/testing/path.py",
"sphinx/testing/restructuredtext.py",
"sphinx/testing/util.py",
"sphinx/transforms/__init__.py",
"sphinx/transforms/compact_bullet_list.py",
"sphinx/transforms/references.py",
"sphinx/transforms/i18n.py",
"sphinx/transforms/post_transforms/__init__.py",
"sphinx/transforms/post_transforms/code.py",
"sphinx/transforms/post_transforms/images.py",
"sphinx/util/build_phase.py",
"sphinx/util/template.py",
"sphinx/util/osutil.py",
"sphinx/util/docutils.py",
"sphinx/util/_pathlib.py",
"sphinx/util/cfamily.py",
"sphinx/util/math.py",
"sphinx/util/logging.py",
"sphinx/util/inspect.py",
"sphinx/util/parallel.py",
"sphinx/util/inventory.py",
"sphinx/util/__init__.py",
"sphinx/util/docfields.py",
"sphinx/util/display.py",
"sphinx/util/http_date.py",
"sphinx/util/matching.py",
"sphinx/util/index_entries.py",
"sphinx/util/typing.py",
"sphinx/util/images.py",
"sphinx/util/exceptions.py",
"sphinx/util/requests.py",
"sphinx/util/docstrings.py",
"sphinx/util/rst.py",
"sphinx/util/i18n.py",
"sphinx/util/fileutil.py",
"sphinx/util/png.py",
"sphinx/util/tags.py",
"sphinx/util/texescape.py",
"sphinx/util/nodes.py",
"sphinx/util/_io.py",
"sphinx/writers/text.py",
"sphinx/writers/html5.py",
"sphinx/writers/html.py",
"sphinx/writers/texinfo.py",
"sphinx/writers/latex.py",
"sphinx/writers/xml.py",
"sphinx/writers/manpage.py",
"tests/conftest.py",
"tests/roots/**/*",
"tests/test_addnodes.py",
"tests/test_application.py",
"tests/test_builders/test_build_html_maths.py",
"tests/test_builders/test_build_html_image.py",
"tests/test_builders/test_build_latex.py",
"tests/test_builders/test_build_text.py",
"tests/test_builders/test_build_html_5_output.py",
"tests/test_builders/test_build_changes.py",
"tests/test_builders/test_builder.py",
"tests/test_builders/test_build_html_tocdepth.py",
"tests/test_builders/test_build_html_download.py",
"tests/test_builders/test_build_dirhtml.py",
"tests/test_builders/test_build_warnings.py",
"tests/test_builders/test_build_html_assets.py",
"tests/test_builders/test_build_html.py",
"tests/test_builders/test_build_linkcheck.py",
"tests/test_builders/test_build_manpage.py",
"tests/test_builders/xpath_data.py",
"tests/test_builders/test_build_html_highlight.py",
"tests/test_builders/test_build_epub.py",
"tests/test_builders/test_build_html_code.py",
"tests/test_builders/test_build_texinfo.py",
"tests/test_builders/xpath_util.py",
"tests/test_builders/test_build_gettext.py",
"tests/test_builders/conftest.py",
"tests/test_builders/test_build_html_numfig.py",
"tests/test_builders/test_build.py",
"tests/test_config/test_correct_year.py",
"tests/test_config/test_config.py",
"tests/test_directives/test_directive_patch.py",
"tests/test_directives/test_directive_code.py",
"tests/test_directives/test_directive_other.py",
"tests/test_directives/test_directive_option.py",
"tests/test_directives/test_directive_object_description.py",
"tests/test_directives/test_directive_only.py",
"tests/test_directives/test_directives_no_typesetting.py",
"tests/test_domains/test_domain_rst.py",
"tests/test_domains/test_domain_py_pyobject.py",
"tests/test_domains/test_domain_cpp.py",
"tests/test_domains/test_domain_py_canonical.py",
"tests/test_domains/test_domain_js.py",
"tests/test_domains/test_domain_c.py",
"tests/test_domains/test_domain_py_fields.py",
"tests/test_domains/test_domain_py.py",
"tests/test_domains/test_domain_std.py",
"tests/test_domains/test_domain_py_pyfunction.py",
"tests/test_environment/test_environment_indexentries.py",
"tests/test_environment/test_environment_record_dependencies.py",
"tests/test_environment/test_environment_toctree.py",
"tests/test_environment/test_environment.py",
"tests/test_errors.py",
"tests/test_events.py",
"tests/test_extensions/test_ext_doctest.py",
"tests/test_extensions/test_extension.py",
"tests/test_extensions/test_ext_imgconverter.py",
"tests/test_extensions/test_ext_graphviz.py",
"tests/test_extensions/test_ext_apidoc.py",
"tests/test_extensions/test_ext_autodoc.py",
"tests/test_extensions/test_ext_todo.py",
"tests/test_extensions/autodoc_util.py",
"tests/test_extensions/test_ext_extlinks.py",
"tests/test_extensions/test_ext_autodoc_events.py",
"tests/test_extensions/test_ext_githubpages.py",
"tests/test_extensions/test_ext_intersphinx.py",
"tests/test_extensions/test_ext_napoleon.py",
"tests/test_extensions/test_ext_coverage.py",
"tests/test_extensions/ext_napoleon_pep526_data_numpy.py",
"tests/test_extensions/test_ext_autodoc_configs.py",
"tests/test_extensions/test_ext_viewcode.py",
"tests/test_extensions/test_ext_autodoc_preserve_defaults.py",
"tests/test_extensions/test_ext_autodoc_mock.py",
"tests/test_extensions/test_ext_autodoc_autoclass.py",
"tests/test_extensions/test_ext_imgmockconverter.py",
"tests/test_extensions/test_ext_autodoc_autoattribute.py",
"tests/test_extensions/test_ext_ifconfig.py",
"tests/test_extensions/test_ext_autodoc_autofunction.py",
"tests/test_extensions/ext_napoleon_pep526_data_google.py",
"tests/test_extensions/test_ext_duration.py",
"tests/test_extensions/test_ext_autodoc_autoproperty.py",
"tests/test_extensions/test_ext_autosummary.py",
"tests/test_extensions/test_ext_autosectionlabel.py",
"tests/test_extensions/test_ext_napoleon_docstring.py",
"tests/test_extensions/test_ext_autodoc_automodule.py",
"tests/test_extensions/test_ext_autodoc_private_members.py",
"tests/test_extensions/test_ext_math.py",
"tests/test_extensions/test_ext_autodoc_autodata.py",
"tests/test_extensions/test_ext_inheritance_diagram.py",
"tests/test_highlighting.py",
"tests/test_intl/test_catalogs.py",
"tests/test_intl/test_intl.py",
"tests/test_intl/test_locale.py",
"tests/test_markup/test_smartquotes.py",
"tests/test_markup/test_markup.py",
"tests/test_markup/test_parser.py",
"tests/test_markup/test_metadata.py",
"tests/test_project.py",
"tests/test_pycode/test_pycode_parser.py",
"tests/test_pycode/test_pycode_ast.py",
"tests/test_pycode/test_pycode.py",
"tests/test_quickstart.py",
"tests/test_roles.py",
"tests/test_search.py",
"tests/test_toctree.py",
"tests/test_transforms/test_transforms_reorder_nodes.py",
"tests/test_transforms/test_transforms_move_module_targets.py",
"tests/test_transforms/test_transforms_post_transforms_code.py",
"tests/test_transforms/test_transforms_post_transforms.py",
"tests/test_util/test_util_display.py",
"tests/test_util/test_util_inventory.py",
"tests/test_util/intersphinx_data.py",
"tests/test_util/test_util_logging.py",
"tests/test_util/test_util_matching.py",
"tests/test_util/test_util_typing.py",
"tests/test_util/test_util_fileutil.py",
"tests/test_util/test_util_template.py",
"tests/test_util/test_util_docstrings.py",
"tests/test_util/test_util_images.py",
"tests/test_util/test_util.py",
"tests/test_util/test_util_nodes.py",
"tests/test_util/test_util_i18n.py",
"tests/test_util/test_util_rst.py",
"tests/test_util/typing_test_data.py",
"tests/test_util/test_util_docutils.py",
"tests/test_util/test_util_inspect.py",
"tests/test_versioning.py",
"tests/test_writers/test_api_translator.py",
"tests/test_writers/test_docutilsconf.py",
"tests/test_writers/test_writer_latex.py",
]