【问题标题】:Insert relative link in reStructuredText在 reStructuredText 中插入相对链接
【发布时间】:2011-04-07 12:29:36
【问题描述】:

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

我已经建立了一个构建系统,所以所有生成的 html 页面都被转储到一个目录树中。我现在需要在主页(从 reST 生成)中插入指向生成的 Javascript 文档的链接。这需要是一个相对链接,因为文档可能位于不同安装的不同位置。 reST 会自动解析一个完整的 URL,但我不知道如何让它插入一个相对链接。 :ref::doc: 之类的构造似乎没有帮助,因为它们希望目标是 reST。

有什么想法吗?

【问题讨论】:

    标签: documentation restructuredtext jsdoc


    【解决方案1】:

    想通了。下面插入对文档js/index.html的相对引用:

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

    【讨论】:

    • 除非您仍在寻找更好的答案,否则您应该接受自己的答案。这样,在搜索中找到您的问题的人可以看到它有正确的答案。
    • 此参考将很有用:hyperpolyglot.org/lightweight-markup
    猜你喜欢
    • 2012-03-27
    • 1970-01-01
    • 2021-04-06
    • 2016-12-21
    • 2012-12-14
    • 1970-01-01
    • 2017-04-10
    • 2012-07-27
    • 2021-08-29
    相关资源
    最近更新 更多