ReadTheDocs 指南
我在自己的许多项目中都使用过 ReadTheDocs，它确实是一个有用的平台。据我从您的问题中收集到的，您正在尝试从您的存储库（GitHub 存储库？）托管 HTML 文件。但是，ReadTheDocs 不是为托管 HTML 而设计的——它实际上使用Sphinx（一个用 Python 编写的文档构建系统）构建 ReStructuredText 或 Markdown 文件。以下是设置 ReadTheDocs 以托管您的文档的典型场景：
初始化文件
- 首先，使用
pip 安装 Sphinx - 阅读 this 以获取有关如何执行此操作的指南。
- 接下来，进入您计算机上的克隆存储库并在
docs 文件夹中运行sphinx-quickstart（必须是一个空文件夹）。
-
该命令应该会问你一些问题。选择以下答案：
-
Seperate source and build directories?: n
-
Project name：为您的项目提供一个简洁的面向公众的名称
-
Author name(s): 开发 API 的开发者姓名
-
Project release：您的 API 的当前版本
其余的可以保持默认（按回车采用默认选项）
- 将创建的文件提交到您的 GitHub 存储库。
- 注册一个 ReadTheDocs 帐户并导入您的存储库。默认情况下，它会在你的仓库的根目录或
docs 文件夹中构建它看到的任何东西（它会自动确定哪个）。如果一切顺利，您应该可以打开文档页面并查看演示页面。
编写和编辑文档
您现在应该可以编辑文件来创建文档了。 RTD 的设计基于“主题”，大多数页面使用https://github.com/rtfd/sphinx_rtd_theme。主题库通常会提供不错的安装文档。
要编辑您的页面，您需要编辑docs/index.rst。 RST 代表ReStructuredText，类似于 Markdown。你可以在互联网上找到它的备忘单。自动生成的文件如下所示：
.. Test documentation master file, created by
sphinx-quickstart on Mon Mar 19 18:24:58 2018.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
Welcome to Test's documentation!
================================
.. toctree::
:maxdepth: 2
:caption: Contents:
Indices and tables
==================
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`
您可以从底部删除“索引和表格”部分 - 我不完全确定它的用途。
.. toctree:: 是一个通用菜单——您只需要在index.rst 中定义它，您可以在其他页面上忽略它。要创建新的文档页面，请创建一个新的 *.rst 文件。您所称的它将对应于它所呈现的.html 文件。例如，parameters.rst 可通过http://mydocs.readthedocs.org/en/latest/parameters.html 访问。要将parameters.rst 页面添加到您的菜单中，它需要如下所示：
.. toctree::
:maxdepth: 2
:captions: Contents:
parameters
基本上，您需要将您的.rst 文件的名称（不带扩展名）添加到您的index.rst 文件中的.. toctree（而不是其他任何地方）。
应用更改
要应用您所做的更改并将其发布到您的 ReadTheDocs 页面，您只需将新的 .rst 文件提交到 GitHub 上的 master 分支，RTD 将自动为您构建和发布。
如果您还不太了解，RTD 不接受 .html 文件。您不应该将 任何 .html 文件提交到 GitHub，而应提交 .rst 文件。 .rst 文件将由 RTD 构建并发布。
版本
您可以使用 Git 标签来管理文档的版本。更多详细信息，请参阅http://docs.readthedocs.io/en/latest/versions.html（ReadTheDocs 官方文档）。
希望这有用！