Sphinx主题——朱雀

“朱雀（rosefinch）”是一款基于Twitter Bootstrap的Sphinx主题，它集成了由@ethantw开发的“汉字标准格式”CSS框架，从而优化了汉字的网页显示效果。

警告

本主题尚在开发中，暂不推荐使用。

“朱雀”这个名字取自该主题的三个要素：

• 希腊神话怪物斯芬克斯（Sphinx）
• 鸟（Twitter）
• 中文文档优化

主题选项

Rosefinch主题的选项包括：

sidebar_enabled

是否开启侧边栏。取值：

• true：开启
• false：关闭

默认为true。

sidebar_position

侧边栏位置，当sidebar_enabled为false时该选项无效。取值：

• left：左侧
• right：右侧

默认为right。

han_enabled

是否开启简/繁/日汉字显示效果优化。取值：

• true：开启
• false：关闭

默认为true。

han_indent

是否开启汉字首行缩进，当han_eanbled为false时无效。取值：

• true：开启
• false：关闭

默认为true。

search_enabled

是否开启搜索功能。取值：

• true：开启
• false：关闭

默认为false。

注意

由于汉字分词功能尚未开发，暂时禁用本主题的搜索功能。对于部署到线上的文档，可以考虑利用Google的site search代替Sphinx的搜索功能。