如何将从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）。

另外，您可能想查看Ben Welsh 在GitHub上详尽的Sphinx文档教程，其中提供了逐步说明以及基于Fabric的便捷脚本/任务，将这些内容结合在一起，使您开始快速在代码旁边发布文档[... ]通过一个命令。