read-the-docs - 如何在 Mac OS X 上本地测试 github repo mkdocs 构建的文件？

Question

有一个 GitHub 存储库，我喜欢对其 docs 进行更改。它使用 readthedocs 来托管主题，并使用 mkdocs。

我正在使用 macOS Mojave。

我找到了这个https://docs.readthedocs.io/en/latest/install.html安装指南来安装readthedocs。但是我看不到在更改要更改的存储库的文件后如何测试构建的文件mkdocs.yml。

mkdocs.yml那么，当我在 macOS X中对本地进行更改时，如何为 readthedocs 测试构建的文件呢？

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

Answer 1

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

要在本地运行 mkdocs，只需：

1. 分叉回购
2. 在本地克隆 fork
3. 设置一个合适的虚拟环境（因为 textX 是一个 python 库，mkdocs 也是）
4. requirements.txt安装在或requirements_dev.txt取决于 repo中规定的合适的所需库
5. 跑mkdocs serve

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