在Sphinx文档中包含源代码

时间:2011-03-16 09:12:29

标签: python python-sphinx

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

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

  

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

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

2 个答案:

答案 0 :(得分:3)

答案 1 :(得分:0)

在conf.py中加入扩展程序。

extensions = ['sphinx.ext.viewcode']