Ability to add links in signatures

Daniel Svensson avatarDaniel Svensson created an issue

When generating autodoc it's not possible to insert links for the types mentioned in the docstring signature:

 |  mymethod(...)
 |      MyModule.mymethod(self, MyThing c, func=None) -> MyResult

Here it would be nice to be able to link to MyThing and MyResult. Even if it's not possible to do it automatically, you could still enclose MyResult in `` either in the source code, or via the autodoc-process-signature event. Same applies to MyThing.

If such a thing is attempted today, the `` will be shown as is in the HTML output, and no hyperlink will be generated.

Comments (0)

  1. 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.