autodoc：基类以全名显示，而不是尊重导入

Question

我希望我能找到解决这个非常复杂问题的解决方案。

我使用sphinx和intersphinx来记录我的项目。

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

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

有没有办法告诉sphinx在导入基类时产生信息（在我的代码中我来自mongoengine import Document）而不是它的完整模块路径？

以下代码：

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

Answer 1

__module__属性包含定义类的模块的名称。 Document.__module__的值是“mongoengine.document”。

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

Document.__module__ = "mongoengine"