本地构建文档

警告

Windows 不支持文档构建。为了在 Windows 上构建文档，我们建议在 Docker 容器内运行。

要构建文档，请在 PyMC 仓库根目录运行以下命令

安装依赖项

conda install -f conda-envs/environment-docs.yml  # or make sure all dependencies listed here are installed
pip install -e .  # Install local pymc version as installable package

构建文档

pymc 仓库中有一个 Makefile 来帮助文档构建过程。

make clean
make html

make html 是使用 sphinx-build 构建文档的命令。make clean 删除缓存和中间文件。

make clean 步骤并非总是必要的，例如，如果您正在处理特定页面，则可以在不执行 clean 步骤的情况下重建文档，一切都应该正常工作。如果您正在重组内容或编辑 toctree，则需要执行 make clean。

一个好的方法通常是跳过 make clean，这会使 make html 更快，并查看一切是否正常。如果看起来有异常，请先运行 make clean，然后再运行 make html，看看是否可以解决问题，然后再检查其他任何内容。

模拟在 readthedocs 上构建

目标 rtd 也可用于将 make clean 与 sphinx-build 链接起来，并设置一些额外的选项和环境变量，以指示 sphinx 尽可能模拟 readthedocs 构建。

make rtd

重要

这不会重新安装或更新任何依赖项，这与 readthedocs 不同，在 readthedocs 上，所有依赖项在每次构建之前都会安装在干净的环境中。

但是它将执行 core_notebooks 文件夹内的所有 notebook，默认情况下这些 notebook 不会执行。执行 notebook 将会为文档构建增加几分钟时间，因为有 6 个 notebook 的运行时间在 20 秒到 5 分钟之间。

查看生成的文档

make view

这将使用 Python 的 webbrowser 模块在您的浏览器中打开生成的网站。生成的网站是静态的，因此无需设置服务器来预览它。