使sphinx viewcode显示模块源

时间:2014-08-29 09:43:03

标签: python documentation python-sphinx

我正在尝试使用sphinx从一些python片段制作食谱。每个代码段都是一个自包含的Python脚本,并有一个教程类型的doctsring。我想在生成的文档中有一个源链接来显示脚本内容。但是viewcode似乎并没有为模块创建这个链接,而是仅为一个函数或一个带有docstring的类创建。有没有办法哄骗sphinx / viewcode显示脚本代码而不包含任何类/函数?

1 个答案:

答案 0 :(得分:0)

我希望你有两年没有等待答案,但尝试使用文字包含标签。你可以玩弄显示的内容。

有关详细信息,请参阅the sphinx docs