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

Question

我刚刚记录了我的大量代码并学习了如何使用 sphinx 来生成文档。我想将它包含到我的 GitHub 项目页面中，但我不知道如何去做。有谁知道现有的教程或简单的步骤？

Answer 1

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

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

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

Answer 2

John Paulett 的回答显然是正确的，并且对于大多数用户来说可能已经足够了（+1）。

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

Answer 3

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

paver gh_pages_create gh_pages_build

有关如何为您的项目设置它，请参阅优秀的文档（当然使用它自己）。