Sphinx Toctree指令中的外部相对链接 [英] External Relative Link in Sphinx toctree directive

问题描述

我使用Sphinx构建我的文档。我正在使用其他工具作为API参考。我将我的文档放在一个目录中，其中的API引用位于目录名api中。

我希望有一个从文档到API参考的链接。我可以将链接添加到我的Toctree链接，因此：

.. toctree::
   :maxdepth: 1

   starting
   glossary
   main-use-case-flow
   API Reference <http://www.example.com/lib/ios/0.1.0/api/>

问题是我不想放置完整路径，我只想放置相对路径api/

如何使用相对路径而不是绝对路径放置指向外部资源的链接？

推荐答案

我找到了一种可能达到此目的的黑客方法。基本上，Sphinx允许指向文档的路径或需要http://的绝对路径。原来，他们要验证您链接所做的全部工作就是逐字查找http://。

*WARNING: toctree contains reference to nonexisting document u'downloads'*
Downloads <../downloads>

但如果您这样做：

Downloads <../downloads#http://>

没有警告！然而，这确实意味着当用户单击您的链接时，它会将http://片段或命名锚插入到您的页面链接中。如果这不是您的html中的有效命名锚点，它将不会对您的页面执行任何操作(除非您的页面包含某个对该命名锚点执行某些操作的Java脚本)。

这篇关于Sphinx Toctree指令中的外部相对链接的文章就介绍到这了，希望我们推荐的答案对大家有所帮助，也希望大家多多支持IT屋！