雪花石膏:狮身人面像主题

PyPI上的包 CI状态 文档状态 BSD 3条款

什么是雪花石膏?

Alabaster是一个视觉上(c)简洁、响应迅速、可配置的主题狮身人面像文件系统。它需要Python 3.9或更新版本和Sphinx 3.4或更新版本。

它最初是作为第三方主题,现在仍单独维护,但从斯芬克斯1.3,雪花石膏是斯芬克斯的安装时间依赖项,被选中作为默认主题。

此主题的现场示例可以在上看到这个项目自己的网站paramiko.org网站fabfile.org网站pyinvoke.org网站.

有关更多文档,请参阅https://alabaster.readthedocs.io网站/.

特征

  • 易于作为Python包进行安装/使用(小贴士戴夫&埃里克的狮身人面像对于指路);

  • 与源主题相比的样式调整,例如更好的代码块对齐,Github按钮放置,页面源链接移动到页脚,改进的(可选)related-items侧边栏项,等等;

  • 许多自定义挂钩,包括各种边栏和页脚的切换组件;标题/链接/等颜色控制;等;

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

项目背景

雪花石膏是Kenneth Reitz的 “krTheme”狮身人面像主题(这是使用过的在他的请求项目)。肯尼思的主题本身最初是基于Armin Ronacher的主题。非常感谢双方的努力工作。

实施说明

  • 419号面料包含很多我开发Alabaster时的一般说明和想法,特别是注意在两个几乎相同的“姊妹”网站上使用它(单一版本www“info”网站和版本化API文档网站)。

  • 雪花石膏在主题顶部包含/需要一个小狮身人面像扩展自身;这只是为了我们可以注入动态元数据(比如Alabaster自己的版本号)。它没有添加任何其他内容指令等,至少现在还没有。