我从事一个开源项目。
为了便于审查 Python 源代码中的 sphinx 文档更改,我们希望能够以某种方式为每个拉取请求生成并托管文档,就像我们已经为代码覆盖率使用工作服所做的那样。
推送新提交将更新为该拉取请求生成的文档。我们很快就会将文档生成添加到我们的 travis 构建中以查找狮身人面像错误,但最终的视觉审查仍然需要通过拉动分支并在本地生成来在本地完成。
是否有任何 GitHub 应用程序提供托管在拉取请求上生成的网页?
> 2018:您可以制作自己的 GitHub 存储库,使用GitHub pages
.
如果在主分支的gh-pages
分支或doc/
子文件夹中生成文档,则可以在存储库中同时包含代码库和文档。
例如,参见 lneuhaus/pyrpl 问题 85,它说明了如何自动化 Sphinx for Python 文档
cd doc/sphinx
sphinx-apidoc -f -o source/ ../../pyrpl/
make html
您可以使用Syntaf/travis-sphinx
自动执行此操作:
通过 travis-ci 自动构建和部署狮身人面像文档的独立脚本
更新 2022 年第四季度:OP fronsacqc 在评论中添加:
我们最终将构建生成的文档推送到标有静态托管标志的 S3 文件夹中,因此现在每个构建的文档都在 S3 上托管了几天。