如何在 Mac OS X 上本地测试 github 回购 mkdocs 构建的文件?
How to test a github repo mkdocs built files locally on Mac OS X?
有一个 GitHub 我喜欢 make changes to its docs 的回购协议。它使用 readthedocs 作为主题,使用 mkdocs 作为主题。
我正在使用 macOS Mojave。
我找到了这个 https://docs.readthedocs.io/en/latest/install.html 安装指南来安装 readthedocs
。但是在更改要更改的回购协议的 mkdocs.yml
文件后,我看不到如何测试构建的文件。
那么,当我在 macOS X 中本地更改 mkdocs.yml
时,如何测试 readthedocs 的内置文件?
如果有必要,我不介意使用 docker。
我对这个问题的心智模型是错误的。 ReadTheDocs 只是一项使用文档生成器(sphinx 或 mkdocs)并托管生成的输出文件的服务。
在本地 运行 mkdocs,只需:
- fork 回购
- 在本地克隆分支
- 设置合适的虚拟环境(因为 textX 是一个 python 库,mkdocs 也是)
- 根据 repo
安装 requirements.txt
或 requirements_dev.txt
中规定的合适的必需库
- 运行
mkdocs serve
mkdocs 将 运行 在本地 127.0.0.1:8000
供您测试生成的 html 文件。要更改 mkdocs 配置,请转到 mkdocs.yml
有一个 GitHub 我喜欢 make changes to its docs 的回购协议。它使用 readthedocs 作为主题,使用 mkdocs 作为主题。
我正在使用 macOS Mojave。
我找到了这个 https://docs.readthedocs.io/en/latest/install.html 安装指南来安装 readthedocs
。但是在更改要更改的回购协议的 mkdocs.yml
文件后,我看不到如何测试构建的文件。
那么,当我在 macOS X 中本地更改 mkdocs.yml
时,如何测试 readthedocs 的内置文件?
如果有必要,我不介意使用 docker。
我对这个问题的心智模型是错误的。 ReadTheDocs 只是一项使用文档生成器(sphinx 或 mkdocs)并托管生成的输出文件的服务。
在本地 运行 mkdocs,只需:
- fork 回购
- 在本地克隆分支
- 设置合适的虚拟环境(因为 textX 是一个 python 库,mkdocs 也是)
- 根据 repo 安装
- 运行
mkdocs serve
requirements.txt
或 requirements_dev.txt
中规定的合适的必需库
mkdocs 将 运行 在本地 127.0.0.1:8000
供您测试生成的 html 文件。要更改 mkdocs 配置,请转到 mkdocs.yml