如何在Sphinx文档中将成员注释为抽象?

时间:2013-07-24 17:52:33

标签: python documentation python-sphinx abc

以下两个属性定义在Sphinx autodoc html输出中显示完全相同:

@property
def concrete(self):
    """This is the concrete docstring"""
    pass

@abstractproperty
def abstract(self):
    """This is the abstract docstring"""
    pass

Sphinx是否有办法用某种标识符注释抽象方法?我希望在我的文档中可以明显看出我的ABC成员需要实现哪些内容,以及在定义了必需的内容后,您获得的是免费赠品。

1 个答案:

答案 0 :(得分:0)

似乎Sphinx不能做到这一点。自2011年起,它在Sphinx's bitbucket被标记为未解决的问题,并被标记为未来版本的Sphinx的里程碑。