Skip to content

Conversation

@brianschubert
Copy link
Member

Sphinx has an option to warn about references missing targets, aka nitpicky mode.

Enabling this mode in the docs build reveals the following warnings:

.../typing_extensions/doc/index.rst:305: WARNING: py:class reference target not found: types.NoneType [ref.class]
.../typing_extensions/doc/index.rst:471: WARNING: py:mod reference target not found: typing.TypedDict [ref.mod]
.../typing_extensions/doc/index.rst:527: WARNING: py:class reference target not found: types.NoneType [ref.class]
.../typing_extensions/doc/index.rst:558: WARNING: py:class reference target not found: types.NoneType [ref.class]
.../typing_extensions/doc/index.rst:800: WARNING: py:class reference target not found: types.NoneType [ref.class]
.../typing_extensions/doc/index.rst:1371: WARNING: py:data reference target not found: typing.Union [ref.data]

Spot checks show that these hits are indeed missing links:

This fixes those cross-references and leaves nitpicky mode enabled in conf.py to help catch similar issues going forward.

@srittau srittau merged commit d5feeb1 into python:main Sep 3, 2025
23 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants