斯芬克斯ReadTheDocs:如何显示完整的源代码?自动代码示例输出?

2024-04-25 06:45:55 发布

您现在位置:Python中文网/ 问答频道 /正文

我在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上。所以最后我们有:

^{pr2}$

不需要手动运行示例并将输出复制粘贴到docstrings中。在


Tags: 代码文档iohttp示例源代码链接sphinx