本地构建文档

警告

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 步骤并不总是必要的，例如，如果你正在处理一个特定的页面，你可以不经过清理步骤直接重建文档，一切应该都能正常工作。如果你正在重构内容或编辑目录树，那么你需要执行 make clean。

一个好的方法是通常跳过 make clean，这会使 make html 更快，并查看一切的外观。如果某些内容看起来奇怪，依次运行 make clean 和 make html 以查看是否修复了问题，然后再检查其他内容。

模拟在readthedocs上构建

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

make rtd

重要

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

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

查看生成的文档

make view

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