Django/django
11
0
Fork 0
Code Pull Requests Projects Releases Activity

[3.1.x] Made default_role_error use logger.

Browse Source 
This prevents raising errors for translated docs, see
https://github.com/django/djangoproject.com/issues/997

Follow up to 1cdfe8d91215eefaa18c398069dd9c6879a9511d.
Backport of 36a2e9607e3069e875eedfd814d4473d9b6811cb from master
This commit is contained in:
Mariusz Felisiak 2020-06-03 11:42:42 +02:00
parent d193aa8da6
commit e260dec258
1 changed files with 7 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
docs/_ext/djangodocs.py
View File

@ -12,9 +12,9 @@ from sphinx import addnodes
from sphinx.builders.html import StandaloneHTMLBuilder from sphinx.builders.html import StandaloneHTMLBuilder
from sphinx.directives.code import CodeBlock from sphinx.directives.code import CodeBlock
from sphinx.domains.std import Cmdoption from sphinx.domains.std import Cmdoption
from sphinx.errors import ExtensionError, SphinxError from sphinx.errors import ExtensionError
from sphinx.util import logging from sphinx.util import logging
from sphinx.util.console import bold, red from sphinx.util.console import bold
from sphinx.writers.html import HTMLTranslator from sphinx.writers.html import HTMLTranslator
logger = logging.getLogger(__name__) logger = logging.getLogger(__name__)
@ -378,8 +378,9 @@ def default_role_error(
name, rawtext, text, lineno, inliner, options=None, content=None name, rawtext, text, lineno, inliner, options=None, content=None
): ):
msg = ( msg = (
"Default role used (`single backticks`) at line %s: %s. Did you mean " "Default role used (`single backticks`): %s. Did you mean to use two "
"to use two backticks for ``code``, or miss an underscore for a " "backticks for ``code``, or miss an underscore for a `link`_ ?"
"`link`_ ?" % (lineno, rawtext) % rawtext
) )
raise SphinxError(red(msg)) logger.warning(msg, location=(inliner.document.current_source, lineno))
return [nodes.Text(text)], []