Repository navigation
Infra: Fix footnote warnings and allow Sphinx 8.1+ #4087
Description
Activity
I don't think there's a way to ignore specific warnings in Sphinx?
suppress_warnings = [ "ref.footnote", ]
refs https://www.sphinx-doc.org/en/master/usage/configuration.html#confval-suppress_warnings
But it's still probably better to resolve them, rather than ignore. But this could open a path to 8.1.x
Reacted by Hugo van KemenadeFYI, the fix to PEP 725 got (presumably inadvertently) reverted, and 3108 still has one unreferenced footnote, so they should be unticked. Also, PEP 694 has a warning now.
Reacted by Hugo van KemenadeState as of February 2026:
PEP 3108 (#4807)pep-3108.rst:1143: WARNING: Footnote [#] is not referenced.PEP 747
pep-0747.rst:671: WARNING: Footnote [#] is not referenced. [ref.footnote]
pep-0747.rst:674: WARNING: Footnote [#] is not referenced. [ref.footnote]
pep-0747.rst:681: WARNING: Footnote [#] is not referenced. [ref.footnote]PEP 725
pep-0725.rst:1054: WARNING: Footnote [#] is not referenced. [ref.footnote]PEP 703
pep-0703.rst:1828: WARNING: Footnote [#] is not referenced. [ref.footnote]
pep-0703.rst:1874: WARNING: Footnote [#] is not referenced. [ref.footnote]PEP 694
pep-0694.rst:1101: WARNING: Footnote [#] is not referenced. [ref.footnote]PEP 615
pep-0615.rst:938: WARNING: Footnote [#] is not referenced. [ref.footnote]PEP 583 (#4808)pep-0583.rst:780: WARNING: Footnote [#] is not referenced. [ref.footnote]
pep-0583.rst:787: WARNING: Footnote [#] is not referenced. [ref.footnote]
pep-0583.rst:791: WARNING: Footnote [#] is not referenced. [ref.footnote]
pep-0583.rst:795: WARNING: Footnote [#] is not referenced. [ref.footnote]
pep-0583.rst:807: WARNING: Footnote [#] is not referenced. [ref.footnote]
pep-0583.rst:811: WARNING: Footnote [#] is not referenced. [ref.footnote]PEP 516 (#4809)pep-0516.rst:454: WARNING: Footnote [#] is not referenced. [ref.footnote]
pep-0516.rst:457: WARNING: Footnote [#] is not referenced. [ref.footnote]PEP 518 (#4810)pep-0518.rst:518: WARNING: Footnote [#] is not referenced. [ref.footnote]
pep-0518.rst:539: WARNING: Footnote [#] is not referenced. [ref.footnote]State as of mid-April 2026:
Problematic documents:
- PEP 747 (PEP 747: Fix Sphinx warnings #4908)
- PEP 725 (PEP 725: Fix Sphinx warnings #4904)
- PEP 703 (PEP 703: Fix Sphinx warnings #4907)
- PEP 694 (PEP 694: Fix Sphinx warnings #4906)
- PEP 615 (PEP 615: Fix Sphinx warnings #4905)
PEP 747pep-0747.rst:673: WARNING: Footnote [#] is not referenced. [ref.footnote]
pep-0747.rst:676: WARNING: Footnote [#] is not referenced. [ref.footnote]
pep-0747.rst:683: WARNING: Footnote [#] is not referenced. [ref.footnote]PEP 725pep-0725.rst:1054: WARNING: Footnote [#] is not referenced. [ref.footnote]PEP 703pep-0703.rst:1828: WARNING: Footnote [#] is not referenced. [ref.footnote]
pep-0703.rst:1874: WARNING: Footnote [#] is not referenced. [ref.footnote]PEP 694
pep-0694.rst:1101: WARNING: Footnote [#] is not referenced. [ref.footnote]PEP 615pep-0615.rst:938: WARNING: Footnote [#] is not referenced. [ref.footnote]State as of mid-July 2026:
Problematic documents:
- PEP 694 (PEP 694: fix unreferenced footnote #5052)
PEP 694
pep-0694.rst:1803: WARNING: Footnote [#] is not referenced. [ref.footnote]Reacted by Hugo van KemenadeGreat, thank you for working on this! 🚀
So we can revert #4044.
I don't think there's a way to ignore specific warnings in Sphinx?
The current warnings:
pep-0352.rst:279: WARNING: Footnote [#] is not referenced. [ref.footnote]pep-0376.rst:610: WARNING: Footnote [#] is not referenced. [ref.footnote]pep-0376.rst:613: WARNING: Footnote [#] is not referenced. [ref.footnote]pep-0386.rst:501: WARNING: Footnote [#] is not referenced. [ref.footnote]pep-0421.rst:469: WARNING: Footnote [#] is not referenced. [ref.footnote]pep-0421.rst:475: WARNING: Footnote [#] is not referenced. [ref.footnote]pep-0421.rst:490: WARNING: Footnote [#] is not referenced. [ref.footnote]pep-0421.rst:493: WARNING: Footnote [#] is not referenced. [ref.footnote]pep-0472.rst:626: WARNING: Footnote [#] is not referenced. [ref.footnote]pep-0472.rst:629: WARNING: Footnote [#] is not referenced. [ref.footnote]pep-0472.rst:632: WARNING: Footnote [#] is not referenced. [ref.footnote]pep-0504.rst:359: WARNING: Footnote [#] is not referenced. [ref.footnote]pep-0504.rst:362: WARNING: Footnote [#] is not referenced. [ref.footnote]pep-0512.rst:969: WARNING: Footnote [#] is not referenced. [ref.footnote]pep-0512.rst:972: WARNING: Footnote [#] is not referenced. [ref.footnote]pep-0512.rst:975: WARNING: Footnote [#] is not referenced. [ref.footnote]pep-0512.rst:978: WARNING: Footnote [#] is not referenced. [ref.footnote]pep-0512.rst:981: WARNING: Footnote [#] is not referenced. [ref.footnote]pep-0512.rst:984: WARNING: Footnote [#] is not referenced. [ref.footnote]pep-0512.rst:987: WARNING: Footnote [#] is not referenced. [ref.footnote]pep-0512.rst:996: WARNING: Footnote [#] is not referenced. [ref.footnote]pep-0512.rst:998: WARNING: Footnote [#] is not referenced. [ref.footnote]pep-0512.rst:1000: WARNING: Footnote [#] is not referenced. [ref.footnote]pep-0516.rst:455: WARNING: Footnote [#] is not referenced. [ref.footnote]pep-0516.rst:458: WARNING: Footnote [#] is not referenced. [ref.footnote]pep-0518.rst:519: WARNING: Footnote [#] is not referenced. [ref.footnote]pep-0518.rst:540: WARNING: Footnote [#] is not referenced. [ref.footnote]pep-0523.rst:371: WARNING: Footnote [#] is not referenced. [ref.footnote]pep-0523.rst:374: WARNING: Footnote [#] is not referenced. [ref.footnote]pep-0583.rst:783: WARNING: Footnote [#] is not referenced. [ref.footnote]pep-0583.rst:790: WARNING: Footnote [#] is not referenced. [ref.footnote]pep-0583.rst:794: WARNING: Footnote [#] is not referenced. [ref.footnote]pep-0583.rst:798: WARNING: Footnote [#] is not referenced. [ref.footnote]pep-0583.rst:810: WARNING: Footnote [#] is not referenced. [ref.footnote]pep-0583.rst:814: WARNING: Footnote [#] is not referenced. [ref.footnote]pep-0615.rst:938: WARNING: Footnote [#] is not referenced. [ref.footnote]pep-0694.rstpep-0703.rst:1829: WARNING: Footnote [#] is not referenced. [ref.footnote]pep-0703.rst:1875: WARNING: Footnote [#] is not referenced. [ref.footnote]pep-0725.rst:667: WARNING: Footnote [#] is not referenced. [ref.footnote]pep-0747.rst:611: WARNING: Footnote [#] is not referenced. [ref.footnote]pep-0747.rst:614: WARNING: Footnote [#] is not referenced. [ref.footnote]pep-0747.rst:621: WARNING: Footnote [#] is not referenced. [ref.footnote]pep-3108.rst:1131: WARNING: Footnote [#] is not referenced. [ref.footnote]pep-3108.rst:1140: WARNING: Footnote [#] is not referenced. [ref.footnote]pep-3108.rst:1152: WARNING: Footnote [#] is not referenced. [ref.footnote]pep-3108.rst:1162: WARNING: Footnote [#] is not referenced. [ref.footnote]pep-3126.rst:349: WARNING: Footnote [#] is not referenced. [ref.footnote]pep-3141.rst:522: WARNING: Footnote [#] is not referenced. [ref.footnote]pep-3146.rst:1299: WARNING: Footnote [#] is not referenced. [ref.footnote]