让Sphinx从pydoc生成RST类文档

Question

我目前正在将所有现有(不完整)文档迁移到Sphinx.

问题是文档使用Python文档字符串(模块是用C编写的,但可能无关紧要),并且必须将类文档转换为可用于Sphinx的表单.

有sphinx.ext.autodoc,但它会自动将当前文档字符串放到文档中.我想基于当前的文档字符串在(RST)中生成源文件,然后我可以手动编辑和改进.

你会如何将文档字符串转换为Sphinx的RST？

Answer 1

autodoc确实生成了RST,但没有正式的方法可以解决它.获得它的最容易的sphinx.ext.autodoc.Documenter.add_line方法是通过改变方法向我发出它所获得的线.

我想要的只是一次性迁移,输出到stdout对我来说已经足够了:

def add_line(self, line, source, *lineno):
    """Append one line of generated reST to the output."""
    print self.indent + line
    self.directive.result.append(self.indent + line, source, *lineno)

现在,autodoc在运行时打印在stdout上生成RST,您可以简单地将其重定向或复制到别处.