Question

我在我的python项目中使用了sphinx_autodoc_typehints扩展名。

在我的项目中，我对my_base_package之类的其他软件包有一些依赖性。

[setup.py]

setup(
  install_requires=[
    "my_base_package @ git+ssh://xxxxxx"
  ]
)

在我的项目文档中，sphinx是否可以显示/链接到“ my_base_package”中的类，接口和异常？

也许一个例子可以更好地说明我的担忧。例如，在我的“ my_base_package”中，添加了一个可以创建记录器的模块。

[my_base_package]
def create_logger() -> Logger

在依赖“ my_base_package”的项目中，我想创建一个记录器。因此，我使用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()

创建文档时，sphinx显示了记录器的参数类型，但未链接到my_base_package中的实现。这可能吗？

该文件文档的当前设置为：

 .. automodule:: my_project.logger
   :members:

文档链接到Sphinx中的其他软件包

0 个答案: