这样的文件你一定见过吧？这种黑白色调看起来很舒服，整个界面干净简洁却很有档次。本文档主要通过在线文档托管ReadtheDocs、基于Python的文档生成项目Sphinx和我们常用的版本控制工具GitHub来实现。下面来梳理一下如何生成文档。创建仓库首先，我们需要在GitHub上创建一个仓库，并克隆到本地。当然你也可以直接在原仓库上操作。注册账号并连接GitHub然后我们需要在ReadtheDocs官网，https://readthedocs.org/注册一个账号，注册成功后，在设置中选择连接的服务，点击连接到GitHub按钮。项目导入点击个人面板中的导入项目，选择需要创建文档的项目，如果没有找到目标项目，可以点击右上角刷新等待.将构建文档导入项目后，我们点击构建版本就成功创建了文档，稍等片刻即可完成构建。自动添加Webhook后，只需更新GitHub仓库，项目文档就会自动重建。然后我们就可以看到文档的原型，添加文档了。完成以上前期工作后，我们就要手写自己的文档了。首先我们需要安装Sphinx（速度较慢，建议转清华镜像下载），pipinstallsphinxsphinx-autobuildsphinx_rtd_themepipinstallsphinxsphinx-autobuildsphinx_rtd_theme-ihttps://pypi.tuna.tsinghua.edu.cn/simple然后我们进入本地仓库目录进行初始化，sphinx-quickstart一直回车就可以使用默认配置，这里我主要选择源目录和构建目录分开，项目语言使用中文。源码和构建目录分开(y/n)[n]:yProjectlanguage[en]:zh_CN然后我们可以通过修改source/conf.py来更改文档主题和添加markdown文件文件支持（需要安装recommonmark）。importsphinx_rtd_themehtml_theme="sphinx_rtd_theme"html_theme_path=[sphinx_rtd_theme.get_html_theme_path()]fromrecommonmark.parserimportCommonMarkParsersource_parsers={'.md':CommonMarkParser,}source_suffix=['.rst','.md']我们可以传入项目根目录执行以下命令在本地生成html文件在build/html/index.html中制作html并预览项目文档最后我们只需要修改index.rst文件来修改文档的内容，reStructuredText是一个纯文本文件，扩展名为.rst，意为“重组文本”，是一种轻量级的标记语言，旨在易于阅读，它被写成纯文本，可以借助Docutils等程序进行处理，也可以转换成HTML或PDF等多种格式，或通过Sphinx-Doc等程序转换成LaTex、man等格式。具体怎么写，请参考下面给出的链接。参考QuickreStructuredTextSphinx官方文档
