sphinx.ext.napoleon - NumPy style

Anonymous avatarAnonymous created an issue

If I use "sphinx.ext.napoleon" "See Also" sections are only boxed yellowish with bold font and the function names are not automatically converted to references, like they are with "numpydoc" (I did not try using a role like :func: for a would have had to convert all sections then).

Using napoleon together with numpydoc causes some other issues (parameters are printed bold and additionally I get two double asterix (**) around them) so it would be great if napoleon could parse the see also section like numpydoc does.

Version 1.3a0

Comments (3)

  1. Rob Ruana

    Closes #1384: Parse and interpret See Also section the way NumpyDoc does

    The NumpyDoc extension that is developed by the Numpy folks does a lot of extra work interpreting See Also sections. It assumes that the contents of the See Also will always be references to other functions/classes and it tries to deduce what is being referenced.

    I've ported their implementation for See Also sections written in the Numpy style. There is NO extra interpretation done for See Also sections that are written using the Google style.

    → <<cset efb88c8d28a9>>

  2. Log in to comment
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.