将对象添加到Sphinx的全局索引和交叉引用语法中吗?

问题描述 投票:1回答:1

[每次我都必须引用一个方法,而不是:func:`package.subpackage.module.method`,特别是对于经常使用的方法。有没有办法以某种方式“注册” package.subpackage,以便仅module.method就足够了? (更好的是,package.subpackage.module,所以假设没有冲突,method就足够了。)

解决方案不应该将目录添加到packagesubpackage,但是我可以在docs/中添加任何内容。请注意,这里的问题与在文档字符串的模块外部定义的method有关(否则.method起作用)。

每次我都必须引用一个方法,而不是package.subpackage.module.method,特别是对于常用方法。有没有办法以某种方式“注册” package.subpackage,以便...

python python-sphinx cross-reference
1个回答
1
投票

从您看到类,函数或方法的那一刻起,您就可以在索引中简化名称的写法。例如,而不是使用完全限定的名称编写交叉引用:

© www.soinside.com 2019 - 2024. All rights reserved.