Remove backslash stripping in domains.

Adds several ways to reinstate the old behaviour.

Fixes sphinx-doc/sphinx#6462
This commit is contained in:
Jakob Lykke Andersen
2019-10-06 17:23:55 +02:00
parent 593dcaf40c
commit e0f779ba3d
3 changed files with 41 additions and 2 deletions

View File

@@ -42,6 +42,12 @@ Incompatible changes
The existing ones are now more strict, resulting in new warnings.
* The attribute ``sphinx_cpp_tagname`` in the ``desc_signature_line`` node
has been renamed to ``sphinx_line_type``.
* #6462: double backslashes in domain directives are no longer replaced by
single backslashes as default. Each class derived from ObjectDescription
may reenable the stripping for it self. A new configuration value
:confval:`signature_backslash_strip_domain_override` can be used by users
to reenable it per domain as well. Setting it to ``[]`` will reinstate the
old behaviour with backslash stripping in every domain.
Deprecated
----------