Sphinx在变量列表中创建到具有相同名称的类的链接

时间:2018-09-28 17:34:50

标签: python python-sphinx sphinx-apidoc

我正在使用Sphinx的apidoc扩展来生成Python项目的文档。这比我预期的要怪,但我已经完成了大多数工作。但是,一个怪癖让我感到难过。

我有一些带有文档字符串的类,其中包括这样的内容:

"""
:ivar normal_attr1:  This is a normal attribute.
:ivar doppleganger:  This is an attribute with the same name as a class in
    another module.

""""

Sphinx会自动添加一个从“ doppleganger”到其共享名称的类的链接-我找不到阻止它的方法。在通常情况下,我只会更改其中一个名称,但是不幸的是,这两个名称均来自我不敢更改的XSD规范自动生成的代码。

有什么简单的方法可以阻止这些链接的插入?

0 个答案:

没有答案
相关问题