diff options
| author | Takeshi KOMIYA <i.tkomiya@gmail.com> | 2018-01-28 18:58:58 +0900 |
|---|---|---|
| committer | Takeshi KOMIYA <i.tkomiya@gmail.com> | 2018-01-28 18:58:58 +0900 |
| commit | 321b3d49cbf67e665e6fdcf6bc7df673e21a1221 (patch) | |
| tree | 222b21300e009bc8c47f3b5d1f60cea9550c5023 | |
| parent | 01caa52355c276fb0e9c2ab31c5321f63c8bba74 (diff) | |
| download | sphinx-git-321b3d49cbf67e665e6fdcf6bc7df673e21a1221.tar.gz | |
Fix #3952: apidoc: module header is too escaped
| -rw-r--r-- | CHANGES | 1 | ||||
| -rw-r--r-- | sphinx/util/rst.py | 6 | ||||
| -rw-r--r-- | tests/test_util_rst.py | 2 |
3 files changed, 7 insertions, 2 deletions
@@ -26,6 +26,7 @@ Bugs fixed * #4472: DOCUMENTATION_OPTIONS is not defined * #4491: autodoc: prefer _MockImporter over other importers in sys.meta_path * #4490: autodoc: type annotation is broken with python 3.7.0a4+ +* #3952: apidoc: module header is too escaped Testing -------- diff --git a/sphinx/util/rst.py b/sphinx/util/rst.py index 5860b0fd5..a406e0044 100644 --- a/sphinx/util/rst.py +++ b/sphinx/util/rst.py @@ -23,13 +23,15 @@ if False: # For type annotation from typing import Generator # NOQA -symbols_re = re.compile(r'([!-/:-@\[-`{-~])') +symbols_re = re.compile(r'([!--/:-@\[-`{-~])') # symbols without dot(0x2e) logger = logging.getLogger(__name__) def escape(text): # type: (unicode) -> unicode - return symbols_re.sub(r'\\\1', text) # type: ignore + text = symbols_re.sub(r'\\\1', text) # type: ignore + text = re.sub(r'^\.', r'\.', text) # escape a dot at top + return text @contextmanager diff --git a/tests/test_util_rst.py b/tests/test_util_rst.py index 406ea710e..07b9174cc 100644 --- a/tests/test_util_rst.py +++ b/tests/test_util_rst.py @@ -14,3 +14,5 @@ from sphinx.util.rst import escape def test_escape(): assert escape(':ref:`id`') == r'\:ref\:\`id\`' assert escape('footnote [#]_') == r'footnote \[\#\]\_' + assert escape('sphinx.application') == r'sphinx.application' + assert escape('.. toctree::') == r'\.. toctree\:\:' |