在 Sphinx 文档中包含源代码答案

【问题标题】：Including source in Sphinx documentation在 Sphinx 文档中包含源代码
【发布时间】：2011-03-16 09:12:29
【问题描述】：

我正在尝试使用 Sphinx 来记录我的 Python 项目，但我正在努力解决这个工具与 JavaDoc 等用于记录 API 的常用工具之间的差异。当然，我看到 Sphinx 比记录 API 有更多的用途，但它似乎缺少更简单的任务。

我have managed 了解如何让 Sphinx 了解您的包结构，这样您就不必手动将其复制到 ReST 文件中。我的下一个问题是：

是否可以在 Sphinx 中包含所有类的源链接？

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

【问题讨论】：

【解决方案1】：

看看sphinx.ext.viewcode。

【讨论】：

【解决方案2】：

在 conf.py 中包含一个扩展。

extensions = ['sphinx.ext.viewcode']

【讨论】：