Windows安装Sphinx+Github+Readthedocs创建开源电子书

Gitbook在国内无法使用，只能采用其他的平台写电子书了。

本文介绍了如何使用Sphinx创建电子书，用VS Code编辑文档，实时查看文件的网页效果，将电子书托管到Github上，并在Readthedocs平台发布。

安装各类必要工具

安装Git

https://git-scm.com/download/win

安装完成后，用Windows Terminal测试

git --version

安装python

https://www.python.org/downloads/

安装完成后，测试

python -V

pip3 --version

安装sphinx

pip3 install sphinx doc8 sphinx-autobuild

创建文档

安装Github Desktop

登录账号，创建一个项目TestBook，选择合适的License，publish到Github网站上（KX上网），选择公开项目，不需要private。

在本地TeskBook目录中初始化

进入TestBook目录，右键“在此打开Terminal”，键入

sphinx-quickstart

填写必要的项目信息后，即初始化成功。

其中第一个选项，可以选择yes，使目录保持各自独立，有source和build两个文件夹。

编辑文档

安装VS Code，及其插件reStructuredText。

打开TestBook目录，在source目录中新建一个文件夹和文件，编辑。

然后编辑index.rst，将新文件加入到目录中

回到Terminal中，生成html文件查看

make html

在build/html目录中直接打开网页文件，查看效果。

实施预览

也可以在VS Code中实时预览正在编辑的rst文件，点击预览的按钮。

托管到Readthedocs平台

使用Github Desktop commit和push到Github网站上，也可以用命令行。

在 https://readthedocs.org/ 网站用github注册账号，可以看到刚建的TestBook项目。

在网站上构建电子书后，即可查看电子书了。

大功告成！