我只是记录了我的代码加载,并学习了如何使用sphinx来生成文档。我想把它加入到我的github项目页面中,但我不知道怎么做。有没有人知道现有的教程或简单的步骤?
谢谢。
发布于 2009-10-26 07:29:03
github将使用他们的github pages功能为你提供静态内容。实际上,您创建了一个名为gh-pages的分支,并将静态页面提交到该分支中。然后,这些页面将在you.github.com/yourproject上提供。
请参阅http://pages.github.com/上的说明。
在github上使用Sphinx可能会遇到问题,因为Sphinx使用带有前导下划线的目录。您可以通过在包含生成的sphinx html的目录中添加一个名为.nojekyll
的文件来修复此问题。
发布于 2012-06-27 05:13:17
github-tools有一个功能,可以完全满足您的要求:
paver gh_pages_create gh_pages_build
有关如何为您的项目设置它的信息,请参考excellent documentation (当然是使用它自己)。
https://stackoverflow.com/questions/1553800
复制相似问题