小编Sha*_*Dou的帖子

使用 sphinx,是否可以将示例代码片段作为 python 文档字符串的一部分运行和输出?

我是 sphinx 的新手,正在尝试为 python 库制作文档。我在许多 python 文档中看到了示例片段(scikit-learn 是一个很好的例子),这是我真正希望在我的文档中包含的内容。

是否可以在文档字符串中包含代码块示例,并让 sphinx 运行这些代码并自行生成相应的输出?(而不是让我手动输入预期的输出)如果是这样,你能告诉我一些正确语法的例子吗?

python doctest python-3.x python-sphinx

5
推荐指数
0
解决办法
797
查看次数

标签 统计

doctest ×1

python ×1

python-3.x ×1

python-sphinx ×1