在Sphinx文档中包含源代码

Question

我正在尝试使用Sphinx来为我的Python项目写文档，但我对这个工具和通常用来记录API的工具（比如JavaDoc）之间的区别感到困惑。当然，我知道Sphinx的用途远不止于记录API，但在处理这个简单的任务时，它似乎有些不足。

我已经找到了如何让Sphinx了解你的包结构，这样你就不需要手动将其复制到ReST文件中。接下来我遇到的问题是：

用Sphinx能否为所有类的源代码添加链接？

当然，源代码应该格式良好，但由于Sphinx使用的是pygments，我认为这不是问题。

Answer 1

在conf.py文件中添加一个扩展。

extensions = ['sphinx.ext.viewcode']

Answer 2

看看这个链接：sphinx.ext.viewcode。