Read the Docs
是一个开源项目文档托管和阅读工具。它提供了Sphinx文档的多种阅读方式，它主要有以下特点：
支持多种形式的阅读，
web/pdf/epub
等，同时可以全文搜索
支持文档的版本控制，
git/svn
等
支持对
github/gitlab
等仓库中某个标签或分支托管的Sphinx文档的clone、build
支持
webhooks
，当版本控制下的文档有更新时就会自动触发build文档
我们知道github虽然可以托管Sphinx文档，但是它无法解析
build
目录下生成的html文档以web形式展示阅读；这里我们将通过绑定
Read
the
Docs工程
和
github仓库
来实现对github托管的Sphinx文档进行clone克隆、build构建、web展示
注册账号
进入
Read the Docs官网
点击登录，输入用户、邮箱、密码完成注册
此时我们可以通过两种方式创建工程项目：
前面我们说过，绑定github账号后，当你创建工程项目时，它会自动列出可以被导入创建的仓库，直接选择即可，但是不知道为什么，每次我这里都显示
No
remote
repositories
手动导入，这里我选择这种方式
此时，如果我们查看github仓库的
Settings
中的
Webhooks
项自动添加了一个url，该url就是刚才创建的
Read
the
Docs项目地址
，当我们github仓库版本更新，它会自动触发
webhooks机制
，通知该url对应的
Read
the
Docs工程
仓库有版本更新，于是
Read
the
Docs工程
会自动触发clone、build动作，同步github仓库的版本更新
只有在创建项目工程之前绑定github账户，才会自动为github仓库设置
Webhooks
，否则需要手动设置；具体可参考
Webhooks官方文档
问题原因：在
conf.py
配置文件中，我启用了
latex_elements
配置项，该项是Sphinx通过latex方式编译输出PDF文档的相关配置信息；如果使用英文编辑默认配置没什么问题，但是我的文档是用中文编写的，如果没有配置以下红框标注的
preamble
项，latex编译时就会报错，导致项目构建失败
\n
和
\b
都是Python中的转义字符，所以配置中的
\nobreakspace
和
\begin
都需要使用两个
\\
如果将
latex_elements
配置项注释掉，项目构建也不会失败
