[英]Shorter references in a Sphinx documentation for a single-package project
我正在使用单个顶级包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
隐式吗?
包括
.. currentmodule:: my_package
在第一个文件的顶部,然后可以将其保留在引用中。
声明:本站的技术帖子网页,遵循CC BY-SA 4.0协议,如果您需要转载,请注明本站网址或者原文地址。任何问题请咨询:yoyou2525@163.com.