本地构建 PEP
在编辑 PEP 时,在本地查看渲染后的输出会很有帮助。这也可以用来在提交给 PEP 编辑之前,检查 PEP 是否是有效的 reStructuredText。
本文档的其余部分假设您正在使用本地克隆的 PEPs 仓库,并且已安装 Python 3.9 或更高版本。
本地渲染 PEP
- 创建虚拟环境并安装依赖
make venv
如果您没有
make
的访问权限,请运行PS> python -m venv .venv PS> .\.venv\Scripts\activate (venv) PS> python -m pip install --upgrade pip (venv) PS> python -m pip install -r requirements.txt
- (可选)删除之前的构建文件。通常只有在更改渲染系统本身时才需要。
rm -rf build
- 运行构建脚本
make html
如果您没有
make
的访问权限,请运行(venv) PS> python build.py
- 导航到您的 PEPs 仓库的
build
目录,查找 HTML 页面。PEP 0 提供了一个格式化的索引,并可能是一个有用的参考。
build.py
工具
可以通过 build.py
或 Makefile 运行几个附加工具。
请注意,在使用 build.py
之前,必须激活之前创建的虚拟环境
source .venv/bin/activate
或在 Windows 上
PS> .\.venv\Scripts\activate
检查链接
检查 PEP 源代码中链接的有效性(运行 Sphinx 链接检查器)。
python build.py --check-links
make linkcheck
build.py
用法
有关 build.py
脚本命令行选项的详细信息,请运行
python build.py --help