Alabaster:Sphinx主题

什么是Alabaster?

Alabaster是一个视觉上简洁的,响应性的,可配置 Sphinx 文档系统主题。它与Python2+3兼容。

它最初是作为第三方主题,现在仍然单独维护,但从Sphinx1.3开始,Alabaster是Sphinx的安装时依赖项,并被选为默认主题。

项目自身网站paramiko.orgfabfile.orgpyinvoke.org 可以看到此主题的运行示例。

有关更多文档,请访问http://alabaster.readthedocs.io.

注解

您可以通过以下方式安装开发版本 pip install -e git+https://github.com/bitprophet/alabaster/#egg=alabaster .

特征

  • 能够以Python软件包的形式轻松安装/使用(提示 Dave & Eric's sphinx_rtd_theme 为我们指路);

  • 与源主题相比,样式进行了调整,比如更好的挡路代码对齐,Github按钮放置,页面源链接移到页脚,改进的(可选的)相关项目侧栏项目,等等;

  • 多种自定义钩子,包括各种侧边栏和页脚组件的切换;页眉/链接/ETC颜色控制等;

  • 改进了所有自定义(现有和新的)的文档。

项目背景

Alabaster是经过修改(有权限)的版本 Kenneth Reitz's "krTheme" Sphinx theme )这是他的手机里用的那个 Requests 项目)。肯尼思的主题本身最初是基于阿明·罗纳赫(Armin Ronacher)的 Flask 主题。非常感谢两位的辛勤工作。

实施说明

  • Fabric #419 在我开发Alabaster时包含了很多一般性的阐述和想法,特别是打算在两个几乎相同的“姊妹”站点(单一版本www‘info’站点和版本化API文档站点)上使用它。

  • Alabaster在主题本身之上包含/需要一个很小的Sphinx扩展;这正是为了将动态元数据(比如Alabaster自己的版本号)注入到模板上下文中。它没有添加任何额外的指令或类似指令,至少现在没有。