3

我的程序的文档主要是用Sphinx编写的，但它还包括两个自定义 HTML 页面：

这两个 HTML 文件是由程序本身生成的，而不是由 Sphinx 生成的。

我想在Read the Docs上托管我的文档，我可以非常方便地构建和托管两个自定义页面，版本化，以及 Sphinx 文档。

我的程序已经安装在 RtD 构建环境中，因为我启用了安装项目选项。而且由于 RtD 文档提到编写自己的 builder，我认为可以从那里调用我的程序并将 HTML 内容转储到特定位置。

所以我真的有两个问题：

  1. 这是对 Read the Docs 的适当使用吗？我想它不是为托管任意网页而设计的——但话说回来，这些文件不是任意的，它们是文档的重要组成部分。

  2. 我将如何实施它？我很难理解RtD API：这个“构建器”是否与Sphinx 构建器有任何关系？如何将它连接到 RtD？也许某处有一个例子？

4

1 回答 1

3

我使用 Sphinx 的html_extra_path功能达到了预期的结果：

包含额外文件的路径列表 [...] 它们被复制到输出目录。

要生成这些文件，我没有找到比在 my 中conf.py更好的地方，这似乎有点不稳定，但到目前为止有效。当然，在虚拟环境中安装您的项目需要在阅读文档高级设置中启用。

现在我的自定义notices.html和showcase.html处理就像.htmlSphinx 本身生成的页面一样，带有版本控制和重定向：http ://httpolice.readthedocs.io/page/notices.html

于 2017-08-02T17:08:38.050 回答