如何将Sphinx生成的HTML文档上传到GitHub？

Question

我刚刚把我的代码写了很多注释，并学会了怎么用sphinx来生成文档。我想把这些文档放到我的GitHub项目页面上，但我不知道该怎么做。有没有人知道现成的教程或者简单的步骤可以参考？

Answer 1

github-tools 这个工具有一个功能，正好可以满足你的需求：

paver gh_pages_create gh_pages_build

你可以查看这个工具的 很棒的文档（当然是用它自己写的）来了解如何为你的项目进行设置。

Answer 2

John Paulett的回答显然是正确的，对于大多数用户来说已经足够用了（点赞）。

另外，你也可以看看Ben Welsh写的详细教程，里面有关于Sphinx在GitHub上的文档，这个教程提供了逐步的指导，还有一个方便的Fabric脚本/任务，可以把这些内容结合起来，帮助你快速通过一个命令就能把文档和代码一起发布出去[...]。

Answer 3

GitHub可以帮你提供静态内容，使用他们的GitHub Pages功能。简单来说，你需要创建一个叫做gh-pages的分支，然后把你的静态页面放到这个分支里。这样，这些页面就会在你.github.com/你的项目名下显示。

你可以查看详细的说明，访问http://pages.github.com/。

在使用Sphinx和GitHub的时候，你可能会遇到一些问题，因为Sphinx会使用带下划线的文件夹。你可以通过在生成的Sphinx HTML文件夹里添加一个叫做.nojekyll的文件来解决这个问题。