安装

Alabaster需要 Sphinx 3.4 or newer ，并作为默认主题包含在其中。

备注

如果您通过以下方式分发文档 Read the Docs ，则需要通过将此行添加到您的 conf.py ：

html_theme = 'alabaster'

要设置Alabaster，请添加一个显式 html_sidebars 设置以加载Alabaster的自定义侧边栏模板：

html_sidebars = {
    '**': [
        'about.html',
        'navigation.html',
        'relations.html',
        'searchbox.html',
        'donate.html',
    ]
}

就这样!现在，您已经设置了标准的Alabaster主题。有关更多核心配置问题，请继续阅读，或参阅 定制 用于功能/样式选项。

侧边栏

请随意调整 html_sidebars 如您所愿-主题的设计假设您将始终拥有 about.html 被激活了，但除此之外它不会太在意。

• 看见 the Sphinx docs 有关此设置如何运行的详细信息，请参阅。

• Alabaster提供了 about.html (logo, github button + blurb), donate.html (donation/support buttons/links) and navigation.html (a more flexible version of the builtin localtoc/globaltoc 模板)。 searchbox.html 它自带Sphinx。

图像和/或自定义样式表的静电路径

If you're using any of the image-related options listed on 定制 (logo or touch-icon) or a custom stylesheet, you'll also want to tell Sphinx where to get these files from. If so, add a line like this (changing the path if necessary; see the Sphinx docs for 'html_static_path') to your conf.py:

html_static_path = ['_static']