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

Merge pull request #7923 from tk0miya/7894_wrong_source_info

Browse Source 
Fix #7894: gettext: Wrong source info is shown when using rst_epilog
This commit is contained in:
Takeshi KOMIYA 2020-07-08 02:41:45 +09:00 committed by GitHub
commit cbc16eb384
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
4 changed files with 9 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
CHANGES
View File

@ -32,6 +32,7 @@ Bugs fixed
* #4258: napoleon: decorated special methods are not shown * #4258: napoleon: decorated special methods are not shown
* #7715: LaTeX: ``numfig_secnum_depth > 1`` leads to wrong figure links * #7715: LaTeX: ``numfig_secnum_depth > 1`` leads to wrong figure links
* #7846: html theme: XML-invalid files were generated * #7846: html theme: XML-invalid files were generated
* #7894: gettext: Wrong source info is shown when using rst_epilog
* #7869: :rst:role:`abbr` role without an explanation will show the explanation * #7869: :rst:role:`abbr` role without an explanation will show the explanation
from the previous abbr role from the previous abbr role
* C and C++, removed ``noindex`` directive option as it did * C and C++, removed ``noindex`` directive option as it did

7
sphinx/util/rst.py
View File

@ -103,6 +103,11 @@ def prepend_prolog(content: StringList, prolog: str) -> None:
def append_epilog(content: StringList, epilog: str) -> None: def append_epilog(content: StringList, epilog: str) -> None:
"""Append a string to content body as epilog.""" """Append a string to content body as epilog."""
if epilog: if epilog:
content.append('', '<generated>', 0) if 0 < len(content):
source, lineno = content.info(-1)
else:
source = '<generated>'
lineno = 0
content.append('', source, lineno + 1)
for lineno, line in enumerate(epilog.splitlines()): for lineno, line in enumerate(epilog.splitlines()):
content.append(line, '<rst_epilog>', lineno) content.append(line, '<rst_epilog>', lineno)

2
tests/test_parser.py
View File

@ -50,7 +50,7 @@ def test_RSTParser_prolog_epilog(RSTStateMachine, app):
(content, _), _ = RSTStateMachine().run.call_args (content, _), _ = RSTStateMachine().run.call_args
assert list(content.xitems()) == [('dummy.rst', 0, 'hello Sphinx world'), assert list(content.xitems()) == [('dummy.rst', 0, 'hello Sphinx world'),
('dummy.rst', 1, 'Sphinx is a document generator'), ('dummy.rst', 1, 'Sphinx is a document generator'),
('<generated>', 0, ''), ('dummy.rst', 2, ''),
('<rst_epilog>', 0, 'this is rst_epilog'), ('<rst_epilog>', 0, 'this is rst_epilog'),
('<rst_epilog>', 1, 'good-bye reST!')] ('<rst_epilog>', 1, 'good-bye reST!')]

2
tests/test_util_rst.py
View File

@ -32,7 +32,7 @@ def test_append_epilog(app):
assert list(content.xitems()) == [('dummy.rst', 0, 'hello Sphinx world'), assert list(content.xitems()) == [('dummy.rst', 0, 'hello Sphinx world'),
('dummy.rst', 1, 'Sphinx is a document generator'), ('dummy.rst', 1, 'Sphinx is a document generator'),
('<generated>', 0, ''), ('dummy.rst', 2, ''),
('<rst_epilog>', 0, 'this is rst_epilog'), ('<rst_epilog>', 0, 'this is rst_epilog'),
('<rst_epilog>', 1, 'good-bye reST!')] ('<rst_epilog>', 1, 'good-bye reST!')]