如何上传从狮身人面像生成的HTML文档到GitHub？

Question

我只是记录了我的代码的负载，并学会了如何使用狮身人面像生成文档。我想将其包括在我的GitHub项目页面中，但我不知道该怎么办。有人知道现有的教程还是简单的步骤？

谢谢。

Answer 1

GitHub将使用他们的静态内容为您提供静态内容 github页面 特征。本质上，您创建了一个名为GH页面的分支，您可以在其中提交静态页面。然后在you.github.com/yourproject上提供页面。

查看说明 http://pages.github.com/.

您可能会在GitHub上使用狮身人面像的问题遇到问题，因为Sphinx使用带有领先下划线的目录。您可以通过添加一个称为的文件来解决此问题 .nojekyll 在带有生成的狮身人面像HTML的目录中。

Answer 2

约翰·保利特的答案 对于大多数用户来说，显然是正确的，并且可能足够（+1）。

或者，您可能想查看本·威尔士的详尽教程 GitHub上的狮身人面像文档, ，提供逐步指示以及方便 织物 基于脚本/任务将这些联系在一起以使您开始 快速与您的代码一起发布文档[... 通过一个命令。

Answer 3

github-tools 有一项功能完全可以做您的要求：

paver gh_pages_create gh_pages_build

参考 出色的文档 （当然可以使用）如何为您的项目设置它。