制作视频码显示模块源代码

2022-04-21 00:00:00 python python-sphinx

问题描述

我正在尝试使用Sphinx用一些Python代码片段制作一本食谱。每个代码段都是一个自包含的Python脚本,并且有一个教程类型的doctsring。

我希望在生成的文档中有一个源代码链接来显示脚本内容。但是viewcode似乎不会为模块创建此链接,而是仅为具有文档字符串的函数或类创建此链接。是否有办法诱使sphinx.ext.viewcode在不包含任何类/函数的情况下显示脚本代码?


解决方案

我希望您没有坐在那里等待答案,但请尝试使用文字包含标记。您可以摆弄所显示的内容。

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

相关文章