在reStructuredText中插入相对链接

时间:2010-09-02 19:13:56

标签: documentation restructuredtext jsdoc

我正在记录一个包含Python组件和JavaScript组件的库。整个用户文档和Python API文档位于reStructuredText中,使用Sphinx进行处理。 JavaScript API位于jsdoc中,并使用jsdoc-toolkit进行处理。主要输出格式为HTML。我是reST,Sphinx和jsdoc的新手。

我已经建立了一个构建系统,因此所有生成的html页面都被转储到一个目录树中。我现在需要在主页面(从reST生成)中插入生成的Javascript文档的链接。这需要是一个相对链接,因为文档可能位于不同安装的不同位置。 reST将自动解析完整的URL,但我无法弄清楚如何使其插入相对链接。像:ref::doc:这样的构造似乎没有帮助,因为他们希望目标是reST。

有什么想法吗?

1 个答案:

答案 0 :(得分:38)

想出来。以下内容插入文档js/index.html的相对引用:

`Javascript API <js/index.html>`_