python-2.7 - autodoc 一个扩展模拟类的类

Question

我正在尝试在扩展外部类的类上运行 autodoc。

我使用了模拟以便接受导入。

为此，我使用了此博客中描述的内容 http://blog.rtwilson.com/how-to-make-your-sphinx-documentation-compile-with-readthedocs-when-youre-using-numpy-and-scipy/

import mock

MOCK_MODULES = ['de', 'de.xyz', 'de.xyz.class_that_is_extended']
for mod_name in MOCK_MODULES:
  sys.modules[mod_name] = mock.Mock()

我尝试记录的 python 文件如下所示:
从 de.xyz 导入 class_that_is_extended

class extending_class (class_that_is_extended):
'''
  docstring
'''

运行 sphinx 后的结果是，只显示类名和源链接。

当我更改“class extends_class (class_that_is_extended):”这一行时
到“类扩展类(对象):”sphinx/autodoc 生成带有 docstring 的文档。

我怎样才能保持原样并仍然在文档中获得文档字符串？

Answer 1

使用此处发布的方法:
Sphinx-doc :automodule: with Mock imports

我刚刚改变了这一行:

sys.modules[mod_name] = mock.Mock()

到:

sys.modules[mod_name] = mock.Mock(class_that_is_extended=object)

并从 MOCK_MODULES 中删除了 'de.xyz.class_that_is_extended'