链接到Shinx中的源代码文件

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

问题描述

我正在用Sphinx记录一个Python模块。我有一个源代码文件,里面充满了使用我的模块的示例。我想参考一下这份文件。它太长,无法内联为连续代码。有没有办法创建到完整源文件的链接,以代码友好的方式(如文字或行号)格式化?

谢谢。


解决方案

Python3可以做到这一点。例如,the argparse docs链接到源代码(靠近页面顶部,其中显示"源代码")。您可以通过查看source for the docs(从第一个链接链接到左下方HAD列的下方)来了解他们是如何做到这一点的。

我假设他们使用的是标准Sphinx,但我很难在他们的文档中找到:source:...

更新::source:角色已定义here。

相关文章