我可以在阅读文档中构建和托管自定义 HTML 页面吗?
Can I build and host custom HTML pages at Read the Docs?
我程序的文档主要写在Sphinx,但它也包括两个自定义HTML页面:
- 程序生成的example report;
- 关于程序某些功能的 extended reference。
这两个 HTML 文件是由程序本身生成的,而不是由 Sphinx 生成的。
我想在 Read the Docs 上托管我的文档,构建和托管两个自定义页面、版本化以及 Sphinx 文档对我来说会非常方便。
我的程序已经安装在 RtD 构建环境中,因为我启用了 Install Project 选项。由于 RtD 文档提到了 writing your own builder,我认为可以从那里调用我的程序并将其转储到特定位置的 HTML 内容。
所以我真的有两个问题:
阅读文档的这种用法是否合适?我想它不是为托管任意网页而设计的——但话又说回来,这些文件不是任意的,它们是文档的重要组成部分。
我该如何实施?我很难理解 RtD API: is this “builder” related in any way to Sphinx builders?我如何将它连接到 RtD?也许某处有例子?
我使用 Sphinx 的 html_extra_path
功能实现了预期的结果:
A list of paths that contain extra files [...] They are copied to the output directory.
要生成这些文件,我还没有找到比 right in my conf.py
更好的地方,这看起来有点不稳定,但到目前为止可以工作。当然,Install your project inside a virtualenv 需要在 Read the Docs advanced settings 中启用。
现在我的自定义 notices.html
和 showcase.html
的处理方式与 Sphinx 本身生成的 .html
页面一样,具有版本控制和重定向:http://httpolice.readthedocs.io/page/notices.html
我程序的文档主要写在Sphinx,但它也包括两个自定义HTML页面:
- 程序生成的example report;
- 关于程序某些功能的 extended reference。
这两个 HTML 文件是由程序本身生成的,而不是由 Sphinx 生成的。
我想在 Read the Docs 上托管我的文档,构建和托管两个自定义页面、版本化以及 Sphinx 文档对我来说会非常方便。
我的程序已经安装在 RtD 构建环境中,因为我启用了 Install Project 选项。由于 RtD 文档提到了 writing your own builder,我认为可以从那里调用我的程序并将其转储到特定位置的 HTML 内容。
所以我真的有两个问题:
阅读文档的这种用法是否合适?我想它不是为托管任意网页而设计的——但话又说回来,这些文件不是任意的,它们是文档的重要组成部分。
我该如何实施?我很难理解 RtD API: is this “builder” related in any way to Sphinx builders?我如何将它连接到 RtD?也许某处有例子?
我使用 Sphinx 的 html_extra_path
功能实现了预期的结果:
A list of paths that contain extra files [...] They are copied to the output directory.
要生成这些文件,我还没有找到比 right in my conf.py
更好的地方,这看起来有点不稳定,但到目前为止可以工作。当然,Install your project inside a virtualenv 需要在 Read the Docs advanced settings 中启用。
现在我的自定义 notices.html
和 showcase.html
的处理方式与 Sphinx 本身生成的 .html
页面一样,具有版本控制和重定向:http://httpolice.readthedocs.io/page/notices.html