IntenseWebs/sphinx
3
0
Fork 0
mirror of https://github.com/sphinx-doc/sphinx.git synced 2025-02-25 18:55:22 -06:00
Code Issues Packages Projects Releases Wiki Activity

intersphinx: Reduce log severity for ambiguity detection during inventory loading (#12615)

Browse Source
This commit is contained in:
James Addison 2024-07-18 13:15:20 +01:00 committed by GitHub
parent f59f761cfa
commit f081136ebd
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
3 changed files with 17 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
CHANGES.rst
View File

@ -7,6 +7,8 @@ Bugs fixed
* #12859, #9743, #12609: autosummary: Do not add the package prefix when
generating autosummary directives for modules within a package.
Patch by Adam Turner.
* #12613: Reduce log severity for ambiguity detection during inventory loading.
Patch by James Addison.
Release 7.4.5 (released Jul 16, 2024)
=====================================

4
sphinx/util/inventory.py
View File

@ -172,8 +172,8 @@ class InventoryFile:
inv_item: InventoryItem = projname, version, location, dispname
invdata.setdefault(type, {})[name] = inv_item
for ambiguity in actual_ambiguities:
logger.warning(__("inventory <%s> contains multiple definitions for %s"),
uri, ambiguity, type='intersphinx', subtype='external')
logger.info(__("inventory <%s> contains multiple definitions for %s"),
uri, ambiguity, type='intersphinx', subtype='external')
return invdata
@classmethod

16
tests/test_util/test_util_inventory.py
View File

@ -49,12 +49,22 @@ def test_read_inventory_v2_not_having_version():
('foo', '', '/util/foo.html#module-module1', 'Long Module desc')
def test_ambiguous_definition_warning(warning):
def test_ambiguous_definition_warning(warning, status):
f = BytesIO(INVENTORY_V2_AMBIGUOUS_TERMS)
InventoryFile.load(f, '/util', posixpath.join)
assert 'contains multiple definitions for std:term:a' not in warning.getvalue().lower()
assert 'contains multiple definitions for std:term:b' in warning.getvalue().lower()
def _multiple_defs_notice_for(entity: str) -> str:
return f'contains multiple definitions for {entity}'
# was warning-level; reduced to info-level - see https://github.com/sphinx-doc/sphinx/issues/12613
mult_defs_a, mult_defs_b = (
_multiple_defs_notice_for('std:term:a'),
_multiple_defs_notice_for('std:term:b'),
)
assert mult_defs_a not in warning.getvalue().lower()
assert mult_defs_a not in status.getvalue().lower()
assert mult_defs_b not in warning.getvalue().lower()
assert mult_defs_b in status.getvalue().lower()
def _write_appconfig(dir, language, prefix=None):