我正在写一个 Sphinx具有单个顶级包 my_package 的 Python 项目的文档。要引用此包中的模块/类,我目前使用
:mod:`my_package.my_module`
:class:`my_package.MyClass`
:class:`my_package.my_module.MyOtherClass`
然后这些引用生成为
my_package.my_module
my_package.MyClass
my_package.my_module.MyOtherClass
我的问题是:是否有一种配置 Sphinx 的方法,以便我可以使用较短的引用,例如
:mod:`my_module`
:class:`MyClass`
:class:`my_module.MyOtherClass`
生成引用为
my_module
MyClass
my_module.MyOtherClass
换句话说,我可以使顶级 my_package 隐式化吗?
请您参考如下方法:
包含
.. currentmodule:: my_package
在您的第一个文件的顶部,然后您可以在引用中将其省略。
