如何将从sphinx生成的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

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

或者您可以查看Ben Welsh的完整教程Sphinx documentation on GitHub，它提供了分步说明以及方便的基于Fabric的脚本/任务，将这些脚本/任务捆绑在一起以帮助您开始通过单个命令快速发布文档和代码[...] 。

Answer 3

github-tools有一项功能完全符合您的要求：

paver gh_pages_create gh_pages_build

请参阅excellent documentation（当然使用自身），了解如何为项目进行设置。