I use the sphinx_autodoc_typehints extension for my python project.
In my project, I have a few dependencies to other packages like my_base_package.
[setup.py]
setup(
install_requires=[
"my_base_package @ git+ssh://xxxxxx"
]
)
Is it possible that sphinx can display / link to classes, interfaces and exceptions from "my_base_package" in the documentation of my project?
Perhaps an example illustrates my concerns a little better. For example in my "my_base_package" I added a module that can create a logger.
[my_base_package]
def create_logger() -> Logger
In my project which depends from "my_base_package", I want to create a logger. Therefore I use the module in my_base_package.
[my_project]
import my_base_package.logger
def setup():
logger = my_base_package.create_logger()
def log(logger: Logger) -> None
"""Log
:param logger: logger to log
"""
logger.log_something()
Creating the documentation, sphinx shows the parameter type for logger, but it is not linked to the implementation in my_base_package. Is this possible?
My current setup for the documentation for this file is:
.. automodule:: my_project.logger
:members:
