如何在本地构建Python文档？

Question

我对要提交合并请求的Python文档进行了一些更改。但在此之前，我想将文档本地构建为HTML，以确保它看起来正确。我该怎么办？

Answer 1

您需要

cd Doc/

而不是顶层cpython/源代码目录，然后README file in that directory解释了该过程：

安装依赖项：

pip install sphinx blurb python-docs-theme

然后运行

make html

文档将内置到Doc/build/html中。您可以像这样使用http.server在本地提供服务：

cd build/html
python -m http.server

然后您应该在http://localhost:8000/

上看到文档的本地版本。