我正在记录一个包含 Python 组件和 JavaScript 组件的库。整个用户文档和 Python API 文档都在 reStructuredText 中,使用 Sphinx 处理。 JavaScript API 在 jsdoc 中,使用 jsdoc-toolkit 进行处理。主要的输出格式将是 HTML。我是 reST、Sphinx 和 jsdoc 的新手。
我已经建立了一个构建系统,所以所有生成的 html 页面都被转储到一个目录树中。我现在需要在主页面(从 reST 生成)中插入一个指向生成的 Javascript 文档的链接。这需要是一个相对链接,因为文档可能位于不同安装的不同位置。 reST 会自动解析一个完整的 URL,但我不知道如何让它插入一个相对链接。构造如 :ref:和 :doc:似乎没有帮助,因为他们希望目标是 reST。
有任何想法吗?
最佳答案
弄清楚了。下面插入对文档js/index.html
的相对引用:
`Javascript API <js/index.html>`_
关于documentation - 在 reStructuredText 中插入相对链接,我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/3630386/