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

Co-authored-by: Adam Turner <[email protected]>
sphinx-doc · Aug 7, 2023 · ac2b759 · ac2b759
1 parent 8cd677f
commit ac2b759
Show file tree

Hide file tree

Showing 3 changed files with 11 additions and 1 deletion.
diff --git a/CHANGES b/CHANGES
@@ -44,6 +44,7 @@ Bugs fixed
   Patch by Ralf Grubenmann.
 * #11529: Line Block in LaTeX builder outputs spurious empty token.
   Patch by Adrian Vollmer.
+* #11196: autosummary: Summary line extraction failed with "e.g."
 
 Testing
 -------

diff --git a/sphinx/ext/autosummary/__init__.py b/sphinx/ext/autosummary/__init__.py
@@ -100,7 +100,7 @@
 periods_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 ------------------------------------------------------

diff --git a/tests/test_ext_autosummary.py b/tests/test_ext_autosummary.py
@@ -102,6 +102,15 @@ def test_extract_summary(capsys):
     doc = ['Blabla, i.e. bla.']
     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.']
     assert extract_summary(doc, document) == ' '.join(doc)