使用alabaster在conf.py中使用html_theme_options和html_logo

Question

你好所有有经验的Sphinx用户，

几天后，我正在与Sphinx一起建立一个小型文档站点。我正在玩Alabaster主题。当我尝试在左上角放置一个徽标时，只能使用构建配置文件'conf.py'中的条目，如下所示：

html_logo = '_static/images/PJS-small.png'

当我尝试使用像这样的Alabaster主题配置时

html_theme_options = { 
    'logo': '_static/images/PJS-small.png',
    'logo_name': True,
    'description': 'one more logo'
}

侧边栏上方没有徽标。

我想使用主题配置，因为我可以放置字幕和其他类似的东西。

有没有人知道如何使用Alabaster配置，就像它有记录一样？

非常感谢您的帮助。

Answer 1

在主题配置（theme.conf）文件中，您需要使用以下语法：

logo = images/PJS-small.png
logo_name = true
description = one more logo

请注意，徽标路径中没有_static目录（它位于主题的HTML模板中）和小写布尔值。

但是，您可以通过Sphinx项目配置文件（html_theme_options）中的conf.py对象设置任何主题配置变量。

Answer 2

您必须在html_sidebars文件中添加conf.py设置：

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

此设置在Alabaster installation instructions。

的末尾进行了描述