为什么 Sphinx 不记录我的 class?
Why does Sphinx not document my class?
我有一个模块有 4 个 classes
class B(object):
"""Docstring for B."""
pass
class C(B):
"""Docstring for C."""
pass
class D(B):
"""Docstring for D."""
pass
class A(object):
"""Docstring for A."""
c = C()
d = D()
只有 class A 在 API 中可访问,连同它的属性 c 和 d(C 和 D 的实例)
Sphinx 生成的文档仅显示 classes A、C 和 D
这是预期的行为吗?
Sphinx 没有任何问题。问题是我在 "class" 行和文档字符串之间有一行代码。既然我已经删除了它,它就可以完美地工作了-尴尬
我有一个模块有 4 个 classes
class B(object):
"""Docstring for B."""
pass
class C(B):
"""Docstring for C."""
pass
class D(B):
"""Docstring for D."""
pass
class A(object):
"""Docstring for A."""
c = C()
d = D()
只有 class A 在 API 中可访问,连同它的属性 c 和 d(C 和 D 的实例)
Sphinx 生成的文档仅显示 classes A、C 和 D
这是预期的行为吗?
Sphinx 没有任何问题。问题是我在 "class" 行和文档字符串之间有一行代码。既然我已经删除了它,它就可以完美地工作了-尴尬