search

pdoc3 / pdoc

:snake: :arrow_right: :scroll: Auto-generate API documentation for Python projects
https://pdoc3.github.io/pdoc/
GNU Affero General Public License v3.0
1.12k stars 145 forks source link

Feature Request: Add option to provide links to external documentation #387

Closed USSX-Hares closed 2 years ago

USSX-Hares commented 2 years ago

Please, add an option to provide links to external documentation. I.e., if function returns django or tornado class, it would be nice to be able to go to that module documentation. The same for docs.python.org.

As I see it, the user can provide a custom function or regexp that generates URLs for the specific module, and a module name when this function should be applied. For built-ins, this function should be delivered with pdoc3.

kernc commented 2 years ago

Agreed. Duplicate of https://github.com/pdoc3/pdoc/issues/85. Please follow that issue.