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

Fix #8342: Emit a warning if a unknown domain is given for directive or role

Browse Source 
Currently, Sphinx mention nothing if users use unknown domain in their
documents (ex. `.. unknown:directive::`, `:unknown:role` and so on).
This starts to warn them to be clear non acceptable mark-ups.

refs: #8342
This commit is contained in:
Takeshi KOMIYA 2020-10-28 01:44:18 +09:00
parent f1af7dc84f
commit 9cd3e1a389
2 changed files with 6 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
CHANGES
View File

@ -41,6 +41,9 @@ Features added
Bugs fixed
----------
* #8342: Emit a warning if a unknown domain is given for directive or role (ex.
``:unknown:doc:``)
Testing
--------

3
sphinx/util/docutils.py
View File

@ -28,6 +28,7 @@ from docutils.statemachine import StateMachine, State, StringList
from docutils.utils import Reporter, unescape
from sphinx.errors import SphinxError
from sphinx.locale import _
from sphinx.util import logging
from sphinx.util.typing import RoleFunction
@ -208,6 +209,8 @@ class sphinx_domains:
element = getattr(domain, type)(name)
if element is not None:
return element, []
else:
logger.warning(_('unknown directive or role name: %s:%s'), domain_name, name)
# else look in the default domain
else:
def_domain = self.env.temp_data.get('default_domain')