在Python Sphinx文档中记录模块/类/函数主体
有没有办法通过Sphinx文档输出一个函数或类的具体代码内容,利用它的自动文档功能?我现在用自动文档功能效果很好。除了文档中能提取到文档字符串外,我还想要每个函数都有一个可以点击的链接,点击后能显示出源代码……这样可以吗?
这就是我现在文档的大致样子:
.. module:`foo.mymodule`
Title
===================
.. automodule:: foo.mymodule
.. autoclass:: MyModulesClass
:members:
:undoc-members:
2 个回答
1
我不这么认为。Autodoc 只是用来从源代码中提取文档的工具。
2
如果这还有用的话:这个viewcode扩展可以做到这一点,不过需要使用Sphinx的开发版本(1.0)。