如何将从狮身人面像生成的html文档上传到github？

Question

我刚刚记录了我的代码，并学会了如何使用sphinx生成文档。我想把它包含到我的github项目页面中，但我不知道如何去做。有没有人知道现有的教程或简单的步骤来做到这一点？

谢谢。

Answer 1

github将为您使用它们的静态内容github pages功能。本质上，你创建一个名为gh-pages的分支，你将静态页面提交到这个分支中。然后将这些页面发送到you.github.com/yourproject。

请参阅http://pages.github.com/的说明。

您可能会遇到在github上使用Sphinx的问题，因为Sphinx使用具有前导下划线的目录。您可以通过在生成的sphinx html目录中添加一个名为.nojekyll的文件来解决此问题。

Answer 2

github-tools有一个功能正是做你所要求的：

paver gh_pages_create gh_pages_build 

参考excellent documentation（当然使用本身）如何将其设置为您的项目。

Answer 3

John Paulett's answer显然是正确的，可能已经足够用于大多数用户（+1）。

或者你可能想看看本·威尔士的深入教程Sphinx documentation on GitHub，它提供了分步说明，以及一个方便Fabric基于脚本/任务捆绑那些在一起让你开始快速发布文档旁边代码[。 ..]通过一个命令。