为github页面准备sphinx文档系统的html输出的脚本。
sphinxtogithub的Python项目详细描述
注意！
此项目旨在帮助您绕过Github页面Jekyll 忽略以下划线开头的顶级目录的行为。
通过在根目录中创建.nojekyll，可以更简洁地解决这个问题 您的github页面将禁用jekyll，如here和here所述。
这使得这个项目基本上毫无用处！感谢acdha让我意识到这一点。
什么？
准备sphinx文档的html输出的python脚本 github页面的系统。
它重命名任何以下划线开头的顶级文件夹并编辑任何 在HTML文件中对它们的引用。
为什么？
github使用jekyll处理传入的html，jekyll相信顶级文件夹 以下划线开头是特殊的，不允许访问其内容 到服务器。这与sphinx不兼容，sphinx在 静态内容的文件夹名称的开头。
用法
sphinxtogithub.py脚本可以在命令行上运行或用作 狮身人面像延伸。
延伸
将脚本放在PYTHONPATH上，并将sphinxtogithub添加到 sphinx项目中conf.py文件中的扩展名列表：
extensions = [ "sphinxtogithub" ]
此外，还可以使用三个配置变量来控制 分机。第一个启用/禁用扩展，第二个启用详细 输出和第三个确定用于读写的编码 文件夹。前两个默认为True，第三个设置为utf-8：
sphinx_to_github = True sphinx_to_github_verbose = True sphinx_to_github_encoding = "utf-8"
命令行
以html输出目录的路径作为第一个运行脚本 争论。基本输出有一个--verbose标志。
更多信息
从github安装
应该可以使用pip从github直接安装此工具：
pip install -e git+git://github.com/michaeljones/sphinx-to-github.git#egg=sphinx-to-github
多亏了winhamwr的工作。
要求
脚本使用/usr/bin/env和python。
运行测试
可以使用setuptoolstest目标运行单元测试。例如：
$ python setup.py test
替代方案
dinoboff的项目 github-tools提供了类似的 功能与更全面的帮助工具集结合在一起 您可以在github上管理基于python的项目。
欢迎加入QQ群-->： 979659372
