用于准备Sphinx文档系统html输出的脚本，适用于GitHub页面。
项目描述
注意！
本项目旨在帮助您绕过GitHub页面Jekyll的行为，即忽略以下划线开头的顶级目录。
通过在GitHub页面的根目录下创建一个.nojekyll文件，可以以更整洁的方式解决这个问题，这将禁用Jekyll，具体请参阅此处和此处。
这使得本项目在很大程度上变得无用！感谢acdha让我了解到这一点。
什么？
这是一个Python脚本，用于准备Sphinx文档系统为GitHub页面生成的HTML输出。
它会重命名任何以下划线开头的顶级文件夹，并编辑HTML文件中对它们的任何引用。
为什么？
GitHub使用Jekyll处理传入的HTML，Jekyll认为以下划线开头的顶级文件夹是特殊的，并且不允许其内容被服务器访问。这与Sphinx不兼容，Sphinx在文件夹名称的起始位置使用下划线来表示静态内容。
使用方法
可以在命令行上运行sphinxtogithub.py脚本，也可以将其用作Sphinx扩展。
扩展
将脚本放置在 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。
运行测试
可以使用 setuptools 的 test 目标来运行单元测试。例如：
$ python setup.py test
替代方案
dinoboff 的项目 github-tools 提供了类似的功能，并附带一套更全面的工具，可以帮助你在 GitHub 上管理基于 Python 的项目。
致谢
感谢
他们为 Sphinx 和 GitHub 团队对页面功能所做的贡献，这些贡献开始超过我的贡献。
sphinxtogithub-1.1.0.tar.gz 的散列
| 算法 | 散列摘要 | |
|---|---|---|
| SHA256 | 15222b1ea55f83dfdf1e09a76d4ef1b9273a2590b73a5a16c4bff972894eae4e |
|
| MD5 | ed77afb540f41c2d86267096142539ae |
|
| BLAKE2b-256 | bb2647f00ce30c9e91ae5d8e9c9dcd7907a46d4e5f87c2e2485472d33c453f90 |
