如何在Mac OS X上本地测试github repo mkdocs内置文件？

Question

有一个我喜欢make changes to its docs的GitHub存储库。它使用readthedocs主持和主题的mkdocs。

我正在使用macOS Mojave。

我发现了此https://docs.readthedocs.io/en/latest/install.html安装指南来安装readthedocs。但是在更改要更改的仓库的mkdocs.yml文件之后，我看不到如何测试内置文件。

因此，当我在macOS X本地对mkdocs.yml进行更改时，如何测试readthedocs的内置文件？

如果必要的话，我不介意使用docker。

Answer 1

我对问题的心理模型是错误的。 ReadTheDocs只是一项使用文档生成器（sphinx或mkdocs）并托管生成的输出文件的服务。

要在本地运行mkdocs，只需：

1. 分叉仓库
2. 在本地克隆叉子
3. 设置合适的虚拟环境（因为textX是python库，因此mkdocs也是如此）
4. 根据存储库安装requirements.txt或requirements_dev.txt中所述的合适的必需库
5. 运行mkdocs serve

mkdocs将在127.0.0.1:8000本地运行，以供您测试生成的html文件。要更改mkdocs配置，请转到mkdocs.yml