Skip to content

Commit 60f88cc

Browse files
Add ref.any as a warning sub-type (sphinx-doc#12739)
Co-authored-by: Adam Turner <[email protected]>
1 parent 705c1be commit 60f88cc

File tree

3 files changed

+11
-2
lines changed

3 files changed

+11
-2
lines changed

CHANGES.rst

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -47,10 +47,10 @@ Features added
4747
* #13065: Enable colour by default in when running on CI.
4848
Patch by Adam Turner.
4949
* Allow supressing warnings from the :rst:dir:`toctree` directive when a glob
50-
pattern doesn't match any documents, via the new ``toc.glob_not_matching``
50+
pattern doesn't match any documents, via the new ``toc.empty_glob``
5151
warning sub-type.
5252
Patch by Slawek Figiel.
53-
* #9732: Add the new ``autodoc.mock_objects`` warnings sub-type.
53+
* #9732: Add the new ``autodoc.mocked_object`` warnings sub-type.
5454
Patch by Cyril Roelandt.
5555
* #7630, #4824: autodoc: Use :file:`.pyi` type stub files
5656
to auto-document native modules.
@@ -70,6 +70,9 @@ Features added
7070
which defaults to ``True`` for backwards compatibility.
7171
The default will change to ``False`` in Sphinx 10.
7272
Patch by Adam Turner.
73+
* #9732: Add the new ``ref.any`` warnings sub-type
74+
to allow suppressing the ambiguous 'any' cross-reference warning.
75+
Patch by Simão Afonso and Adam Turner.
7376

7477
Bugs fixed
7578
----------

doc/usage/configuration.rst

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1384,6 +1384,7 @@ Options for warning control
13841384
* ``misc.copy_overwrite``
13851385
* ``misc.highlighting_failure``
13861386
* ``ref.citation``
1387+
* ``ref.any``
13871388
* ``ref.doc``
13881389
* ``ref.footnote``
13891390
* ``ref.keyword``
@@ -1487,6 +1488,9 @@ Options for warning control
14871488
.. versionadded:: 8.2
14881489
Added ``autodoc.mocked_object``
14891490

1491+
.. versionadded:: 8.2
1492+
Added ``ref.any``
1493+
14901494

14911495
Builder options
14921496
===============

sphinx/transforms/post_transforms/__init__.py

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -188,6 +188,8 @@ def stringify(name: str, node: Element) -> str:
188188
target,
189189
candidates,
190190
location=node,
191+
type='ref',
192+
subtype='any',
191193
)
192194
res_role, newnode = results[0]
193195
# Override "any" class with the actual role type to get the styling

0 commit comments

Comments
 (0)