我正在为一个带有单个顶级包my_package
的Python项目编写Sphinx文档。要引用此包中的模块/类,我目前使用
: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
吗?
答案 0 :(得分:1)
包括
.. currentmodule:: my_package
在您的第一个文件的顶部,然后您可以将其保留在参考文件中。