在 Sphinx 文档中包含源代码

And*_*rea 2 python python-sphinx

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

已经设法找到如何让 Sphinx 了解您的包结构,这样您就不必手动将其复制到 ReST 文件中。我的下一个问题是:

是否可以包含 Sphinx 所有类的源链接?

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