mirror of
https://github.com/sphinx-doc/sphinx.git
synced 2025-02-25 18:55:22 -06:00
04bd0df100
The key issue this commit seeks to address, is that existing tools / documentation often lead users to mistakenly use object types and not role names, a classic example being `function` not `func` Previously, the warning message for using e.g. `` external:function`target` `` (with `py` as the default domain), would be: ``` WARNING: role for external cross-reference not found: function ``` This gives no information to the user on how to fix the issue, even though there is actually quite an easy fix This commit adds logic to create more specific / helpful warning messages, e.g. ``` WARNING: role for external cross-reference not found in domains 'py', 'std': 'function' (perhaps you meant one of: 'py:func', 'py:obj') ``` This goes through the same original logic but, if the role is not found, it will look if the role name is actually an available object type on the domain(s), and then suggest its related roles. This commit also reverts #12133, which provided a (silent) fallback to auto convert an object type to a role name. |
||
|---|---|---|
| .. | ||
| __init__.py | ||
| autodoc_util.py | ||
| ext_napoleon_pep526_data_google.py | ||
| ext_napoleon_pep526_data_numpy.py | ||
| test_ext_apidoc.py | ||
| test_ext_autodoc_autoattribute.py | ||
| test_ext_autodoc_autoclass.py | ||
| test_ext_autodoc_autodata.py | ||
| test_ext_autodoc_autofunction.py | ||
| test_ext_autodoc_automodule.py | ||
| test_ext_autodoc_autoproperty.py | ||
| test_ext_autodoc_configs.py | ||
| test_ext_autodoc_events.py | ||
| test_ext_autodoc_mock.py | ||
| test_ext_autodoc_preserve_defaults.py | ||
| test_ext_autodoc_private_members.py | ||
| test_ext_autodoc.py | ||
| test_ext_autosectionlabel.py | ||
| test_ext_autosummary.py | ||
| test_ext_coverage.py | ||
| test_ext_doctest.py | ||
| test_ext_duration.py | ||
| test_ext_extlinks.py | ||
| test_ext_githubpages.py | ||
| test_ext_graphviz.py | ||
| test_ext_ifconfig.py | ||
| test_ext_imgconverter.py | ||
| test_ext_imgmockconverter.py | ||
| test_ext_inheritance_diagram.py | ||
| test_ext_intersphinx.py | ||
| test_ext_math.py | ||
| test_ext_napoleon_docstring.py | ||
| test_ext_napoleon.py | ||
| test_ext_todo.py | ||
| test_ext_viewcode.py | ||
| test_extension.py | ||