将 sphinx 输出中的部分链接到 RST 源

Posted 2023-03-30

【中文标题】将 sphinx 输出中的部分链接到 RST 源

【英文标题】：Linking sections in sphinx output to the RST source

【发布时间】：2019-02-27 21:13:56

【问题描述】：

sphinx 文档页面或部分是否有方法或插件可以链接到源代码 - 不是指向应用程序源代码的链接，而是实际的 sphinx RST 文件。

例如，链接到 github 上的 RST 源文件的“贡献于本节”的链接。

如果存在，我不知道该怎么称呼它才能找到它，我看到的只是链接到源代码的选项。

【参考方案1】：

是的。是配置值html_show_sourcelink，大部分主题都支持：

html_show_sourcelink 如果true（并且html_copy_source 也是true），指向reST 源的链接将添加到侧边栏中。默认为True。

【讨论】：

谢谢，但我的目标是链接到 github 存储库。有了这个功能，它知道文件名和可能的行号，但是链接到复制的源文件并不能真正达到我们的目标。

这个选项让我找到了一些可能有效的随机脚本，例如gist.github.com/mgedmin/6052926

我们通过扩展基本主题为 Pyramid 文档实现了一个 Edit me on GitHub 链接。见github.com/Pylons/pylons-sphinx-themes/blob/master/…

这可行，你在哪里定义github_user 之类的？我尝试将它们放在 conf.py 中，但这似乎不是正确的位置。编辑：没关系，这个 RTD 页面帮助了 docs.readthedocs.io/en/latest/vcs.html