让viewcode显示模块源代码

3 投票
1 回答
636 浏览
提问于 2025-04-18 19:30

我正在用Sphinx把一些Python代码片段做成一本食谱。每个代码片段都是一个独立的Python脚本,并且都有类似教程的文档说明。

我想在生成的文档中添加一个链接,能显示脚本的内容。但是viewcode似乎只会为有文档说明的函数或类创建这个链接,而不会为模块创建。有没有办法让sphinx.ext.viewcode显示脚本代码,而不需要在里面有任何类或函数呢?

1 个回答

1

我希望你没有等了两年才想要这个答案,不过你可以试试直接使用包含标签。你可以自己调整一下显示的内容。

更多细节可以查看 Sphinx 文档

撰写回答