Shorter references in a Sphinx documentation for a single-package project(单包项目的Sphinx文档中的较短参考)
本文介绍了单包项目的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文档中的较短参考的文章就介绍到这了,希望我们推荐的答案对大家有所帮助,也希望大家多多支持编程学习网!
沃梦达教程
本文标题为:单包项目的Sphinx文档中的较短参考
基础教程推荐
猜你喜欢
- Python 的 List 是如何实现的? 2022-01-01
- 哪些 Python 包提供独立的事件系统? 2022-01-01
- 症状类型错误:无法确定关系的真值 2022-01-01
- 将 YAML 文件转换为 python dict 2022-01-01
- 使用Python匹配Stata加权xtil命令的确定方法? 2022-01-01
- 使用 Google App Engine (Python) 将文件上传到 Google Cloud Storage 2022-01-01
- 使 Python 脚本在 Windows 上运行而不指定“.py";延期 2022-01-01
- 如何在Python中绘制多元函数? 2022-01-01
- 如何在 Python 中检测文件是否为二进制(非文本)文 2022-01-01
- 合并具有多索引的两个数据帧 2022-01-01