缩短Sphinx文档中的交叉引用

时间:2018-09-13 02:09:02

标签: python python-sphinx documentation-generation

当使用intersphinx扩展名从外部Python包中交叉引用对象时,如果将定义对象的模块嵌套了几层,则引用会变得很长。具体来说,我正在使用Sympy库,该库导致经常不得不在各处输入:class:`sympy.core.symbol.Symbol`之类的东西。

我知道您可以:

  1. 在引用前加上~字符,以使链接在生成的文档中仅显示为“符号”。
  2. 截断开始的路径,并在开头留点,例如.Symbol.symbol.Symbol.core.symbol.Symbol等。
  3. 如果我知道不会有任何冲突,只需使用Symbol并依靠Sphinx来找到它。

#1对于生成的文档很好,但是在源文件中仍然非常冗长。 #2和#3较短,但忽略了最重要的部分,即实际的根包。

有没有一种缩短引用的方式,可以删除中间模块名称,但又保留根包名称空间?像sympy.*.Symbolsympy::Symbol之类的东西?

0 个答案:

没有答案