Alabaster:Sphinx主題?

什么是Alabaster??

Alabaster是一個視覺上簡潔的,響應性的,可配置 Sphinx 文檔系統主題。它與Python2+3兼容。

它最初是作為第三方主題,現在仍然單獨維護,但從Sphinx1.3開始,Alabaster是Sphinx的安裝時依賴項,并被選為默認主題。

項目自身網站 , paramiko.org , fabfile.orgpyinvoke.org 可以看到此主題的運行示例。

有關更多文檔,請訪問http://alabaster.readthedocs.io.有關路線圖,請參閱維護人員的 roadmap page 。

注解

您可以通過以下方式安裝開發版本 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自己的版本號)注入到模板上下文中。它沒有添加任何額外的指令或類似指令,至少現在沒有。