BUG: Allow wrapped lines in "See also" numpy section (#141)

* allow wrapped lines in "see also" numpy section * minor update Co-authored-by: kernc <kerncece@gmail.com>
pdoc3 · Jan 12, 2020 · 30ca5ef · 30ca5ef
1 parent d6eca2a
commit 30ca5ef
Show file tree

Hide file tree

Showing 3 changed files with 5 additions and 0 deletions.
diff --git a/pdoc/html_helpers.py b/pdoc/html_helpers.py
@@ -157,6 +157,7 @@ def _numpy_sections(match):
         """
         section, body = match.groups()
         if section.title() == 'See Also':
+            body = re.sub(r'\n\s{4}\s*', ' ', body)  # Handle line continuation
             body = re.sub(r'^((?:\n?[\w.]* ?: .*)+)|(.*\w.*)',
                           _ToMarkdown._numpy_seealso, body)
         elif section.title() in ('Returns', 'Yields', 'Raises', 'Warns'):

diff --git a/pdoc/test/__init__.py b/pdoc/test/__init__.py
@@ -946,6 +946,8 @@ def test_numpy(self):
 <dd>Function a with its description.</dd>
 <dt><a><code>scipy.random.norm</code></a></dt>
 <dd>Random variates, PDFs, etc.</dd>
+<dt><a><code>pdoc.Doc</code></a></dt>
+<dd>A class description that spans several lines.</dd>
 </dl>
 <h2 id="notes">Notes</h2>
 <p>Foo bar.</p>

diff --git a/pdoc/test/example_pkg/__init__.py b/pdoc/test/example_pkg/__init__.py
@@ -183,6 +183,8 @@ def numpy(self):
         --------
         pdoc.text : Function a with its description.
         scipy.random.norm : Random variates, PDFs, etc.
+        pdoc.Doc : A class description that
+                   spans several lines.
 
         Notes
         -----