如何使用Sphinx Autodoc show-inheritance选项与Intersphinx链接到Django类?

时间:2012-09-07 18:27:52

标签: python django python-sphinx

我正在使用Sphinx Autodoc的show-inheritance选项列出我所有类的基类。其中一些类链接到Django类,但不幸的是Intersphinx无法找到它们。

问题的原因是Autodoc将基类列为(例如)django.forms.widgets.Select,但objects.inv文件Django仅提供列表django.forms.Select。虽然这两个条目都是相同的类,并且两者都是导入它们的有效方法,但这会抛弃Intersphinx。

有没有办法解决这个问题? Django objects.inv还有其他任何源列出的别名吗?

1 个答案:

答案 0 :(得分:0)

好的,我自己解决了这个问题。在我看来,最谨慎的方法是修补Django的objects.inv文件,其中包含缺少的引用。

我已经编写了一个Java代码来自动执行此操作。您可以使用它为任何已发布的Django版本自己创建修补版本。

代码位于https://github.com/applegrew/sphinxutil

另外,我已经提供了Django 1.4.1版本的修补objects.inv文件。