从GutHub上的拉取请求托管构建文档

时间:2018-09-23 14:07:55

标签: python github documentation

我从事一个开源项目。
为了便于审查Python源代码中的狮身人面像文档更改,我们希望能以某种方式为每个请求请求生成并托管文档,就像我们已经为代码覆盖率所做的工作一样。

推动新的提交将更新该请求的生成文档。我们很快将在travis版本中添加文档生成功能以查找狮身人面像错误,但最终的视觉审核仍需要通过拉动分支并在本地生成来在本地进行。

是否有任何GitHub应用程序可以托管在请求请求中生成的网页?

1 个答案:

答案 0 :(得分:0)

您可以使用GitHub pages使自己的GitHub存储库提供页面。

如果您在主分支的UIView.ContentMode.scaleAspectFit分支or the doc/ subfolder中生成文档,则您的代码库和文档都可以在存储库中。

例如参见lneuhaus/pyrpl issue 85,它说明了如何使Sphinx for Python documentation自动化

UIView.ContentMode.scaleAspectFill

您可以使用Syntaf/travis-sphinx将其自动化:

  

一个独立的脚本,用于通过travis-ci自动构建和部署sphinx文档