Sphnix+git+ReadTheDocs写wiki实践笔记记录——ReadTheDocs基本更新

本文链接：https://blog.csdn.net/Astilbe001/article/details/104413087

本文档详细介绍了如何更新reStructuredText格式的文档，并通过sphinx工具生成新的html页面，包括编辑rst文件、配置SPHINXBUILD环境变量及使用makehtml命令的全过程。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

reStructuredText文档更新

文档更新后，必须用sphnix制作新html，因为read the docs只加载html内容。

1. 用编辑器打开需要修改的rst文件，之后保存

2. 进入WIKI的目录下（与make.bat在一级），输入make html

加载完毕后，html即更新。

如果出现以下问题：

The 'sphinx-build' command was not found. Make sure you have Sphinx
installed, then set the SPHINXBUILD environment variable to point
to the full path of the 'sphinx-build' executable. Alternatively you
may add the Sphinx directory to PATH.

If you don't have Sphinx installed, grab it from
http://sphinx-doc.org/

我们需要给SPHINXBUILD配置路径，解决方法如下：

找到python的安装路径，打开script文件，找到“sphinx-build.exe”。
接下来配置SPHINXBUILD的PATH，从而让系统可以直接打开。

据说可以使用命令行解决，然而没看懂这个是什么意思。

SPHINXBUILD <-- C:\Python27\Scripts\sphinx-build.exe

但是我们可以手动设置。
1.W10系统中，找到设置，搜索环境变量。
在这里插入图片描述

2.按照步骤进入到环境变量的编辑中，在这里把刚才的sphinx-build.exe的地址复制进去，注意地址不包括sphins-build.exe。这样系统就可以自动找到这个程序。