单包项目的Sphinx文档中的较短参考

Shorter references in a Sphinx documentation for a single-package project(单包项目的Sphinx文档中的较短参考)

问题描述

我正在为一个具有单个顶层包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

在rst文件的顶部，则可以在引用中省略这一点。

这篇关于单包项目的Sphinx文档中的较短参考的文章就介绍到这了，希望我们推荐的答案对大家有所帮助，也希望大家多多支持编程学习网！