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

autosummary: Extract summary line after "e.g." (#11196)

Browse Source 
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
This commit is contained in:
grayjk 2023-08-07 17:20:30 -04:00 committed by GitHub
parent 8cd677f929
commit ac2b7599d2
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 11 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
CHANGES
View File

@ -44,6 +44,7 @@ Bugs fixed
Patch by Ralf Grubenmann. Patch by Ralf Grubenmann.
* #11529: Line Block in LaTeX builder outputs spurious empty token. * #11529: Line Block in LaTeX builder outputs spurious empty token.
Patch by Adrian Vollmer. Patch by Adrian Vollmer.
* #11196: autosummary: Summary line extraction failed with "e.g."
Testing Testing
------- -------

2
sphinx/ext/autosummary/__init__.py
View File

@ -100,7 +100,7 @@ logger = logging.getLogger(__name__)
periods_re = re.compile(r'\.(?:\s+)') periods_re = re.compile(r'\.(?:\s+)')
literal_re = re.compile(r'::\s*$') literal_re = re.compile(r'::\s*$')
WELL_KNOWN_ABBREVIATIONS = ('et al.', ' i.e.',) WELL_KNOWN_ABBREVIATIONS = ('et al.', 'e.g.', 'i.e.')
# -- autosummary_toc node ------------------------------------------------------ # -- autosummary_toc node ------------------------------------------------------

9
tests/test_ext_autosummary.py
View File

@ -102,6 +102,15 @@ def test_extract_summary(capsys):
doc = ['Blabla, i.e. bla.'] doc = ['Blabla, i.e. bla.']
assert extract_summary(doc, document) == ' '.join(doc) assert extract_summary(doc, document) == ' '.join(doc)
doc = ['Blabla, (i.e. bla).']
assert extract_summary(doc, document) == ' '.join(doc)
doc = ['Blabla, e.g. bla.']
assert extract_summary(doc, document) == ' '.join(doc)
doc = ['Blabla, (e.g. bla).']
assert extract_summary(doc, document) == ' '.join(doc)
doc = ['Blabla, et al. bla.'] doc = ['Blabla, et al. bla.']
assert extract_summary(doc, document) == ' '.join(doc) assert extract_summary(doc, document) == ' '.join(doc)