AutoDoc：基类以全名显示，而不是尊重导入 [英] autodoc: base classes are shown with full name instead of respecting the import

问题描述

我希望我能在这里为这个相当复杂的问题找到解决方案。

我使用狮身人面像和intersphinx来记录我的项目。

我有一个继承自mongoEng.Document的类。

当我使用sphinx-apidoc和sphinx-Build(通过sphinx-QuickStart自动生成的Makefile)构建sphinx文档时，对mongoEng.Document类的引用显示为mongoEng.Document.Document，这实际上是正确的完全限定名，但这是一个问题，因为在mongoEngine项目中，该类被标记为mongoEngine。Document，所以intersphinx根本没有链接。

有没有办法告诉Shinx在导入基类(在我的代码中，我从MongoEngine导入文档中)而不是它的完整模块路径时生成有关基类的信息？

以下代码：

from mongoengine import Document, EmbeddedDocumentListField

class MyDocument(Document):
""" my docstring """

它会生成如下所示的html：

class myproj.models.MyDocument(*args, **values) Bases:
mongoengine.document.Document  <-- intersphinx does not find the link to external doc!

而不是

class myproj.models.MyDocument(*args, **values)
Bases: mongoengine.Document <-- here intersphinx will properly link

推荐答案

__module__属性保存在其中定义类的模块的名称。Document.__module__的值为"mongoEng.Document"。

该属性是可写的，因此解决方法是在代码中添加以下行：

Document.__module__ = "mongoengine"

这篇关于AutoDoc：基类以全名显示，而不是尊重导入的文章就介绍到这了，希望我们推荐的答案对大家有所帮助，也希望大家多多支持IT屋！