Sphinx文檔中對單包項目的較短引用

Question

我正在爲一個Python項目編寫一個Sphinx文檔，其中包含一個頂級包my_package。要引用這個包模塊/班，我目前使用

: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 

我的問題是產生：有沒有配置獅身人面像，這樣我可以用更短的引用的方法一樣

:mod:`my_module` 
:class:`MyClass` 
:class:`my_module.MyOtherClass` 

其產生的參考文獻作爲

my_module 
MyClass 
my_module.MyOtherClass 

換句話說，我可以使頂級my_package隱式？

Answer 1

你的第一個文件的頂部包含

.. currentmodule:: my_package 

，那麼您可以在引用離開了這一點。