Sphinx - ReadTheDocs:如何显示完整的源代码?自动代码示例输出?

时间:2016-12-10 18:16:49

标签: python python-sphinx

我在ReadTheDocs上使用Sphinx来记录Python包。

我的文档:http://linvpy.readthedocs.io/en/latest/

我的GitHub:https://github.com/LCAV/linvpy

1)我们如何在ReadTheDocs上显示完整的源代码?在Numpy中,每个定义旁边都有一个链接[source],链接到相应的源代码。我们怎么能做到这一点?

2)有没有办法让代码示例输出自动计算?例如,如果我在docstrings中编写以下代码示例:

:Example:

>>> 1+2

我希望输出3自动计算并显示在readthedocs上。所以最后我们有:

>>> 1+2
3

无需手动运行示例并将输出复制粘贴到文档字符串中。

0 个答案:

没有答案