快速构建本地locust帮助文档

locust是软件性能测试界中，一个非常出名的库。用python开发性能测试工具，可能第一选择，就是这个。

但是，由于国内网络的原因，很多人都会出现和我一样的情况，不能访问locust的官网帮助文档https://docs.locust.io/ ，这就导致，很多人想学locust，就放弃了。

今天，我来给大家讲解一种本地构建locust最新帮助文档的方法。

这是我本地运行起来的效果。

• 首先，在电脑上安装python3.8及以上的版本。
• 然后，执行

pip install locust

• 安装成功后，把python的Scripts文件夹加入的系统环境变量中。如，我的windows电脑，我安装的是python3.8.x，安装在C:\Program Files\Python38这个目录，就把“C:\Program Files\Python38\Scripts”这个路径，加入系统环境变量。
• 然后，执行

pip install sphinx==4.3.2
pip install sphinx-rtd-theme==0.5.2
pip install readthedocs-sphinx-search==0.1.2
pip install Sphinx-Substitution-Extensions==2020.9.30.0

• 接下来，从github上，下载locust的项目包，路径在：https://github.com/locustio/locust
• 接下来，在自己磁盘的任意路径下，创建一个英文名称的文件夹，cmd命令，进入到这个文件夹。
• 执行：

sphinx-quickstart .

注意：如果上面要求把Scripts文件夹加入系统环境变量没有执行，或没有执行正确，将提示这个命令不是系统命令。

• 接下来，把github上下载的locust源码包中的docs文件夹下的所有内容，复制到这里的source文件夹下。
• 然后，把github下载的locus源码包中的，examples .vscode两个文件夹，复制到与source文件夹同级的位置。

• 然后，在cmd窗口中执行

sphinx-autobuild .\source\ .\build\html

注意：如果上面要求把Scripts文件夹加入系统环境变量没有执行，或没有执行正确，将提示这个命令不是系统命令。

这个命令执行的时间可能会有点长，耐心等待。如果，你等不了，也没关系，你可以让它在那边努力的执行，你用浏览器访问： http://127.0.0.1:8000 或许你已经可以正常阅读locust的最新帮助文档了。

好了，这样，本地就有了一份完整locust帮助文档了。

• 以后，要看，可以进入build\html文件夹中，双击index.html文件，用浏览器打开，就可以阅读。
• 如果要更新新版本的locust帮助文档，重新复制，搞一遍即可。

其实，也是可以直接通过github下载文件，直接生成帮助文档，我这里，拷贝一份出来，只是为了防止误操作。