Question

我正在为我的API库构建文档，并且我已经将readthedocs.io托管了文档，并且得到了Sphinx的支持。我使用pip install为Sphinx安装了Read The Docs主题，而Read the Docs网站目前正在运行文档。

我想更改文档的颜色。我已经通过他们的GitHub存储库GitHub.com进行了一些搜索，并看到了一些关于编辑sass文件的讨论。但是，我似乎无法找到这些文件的位置。

感谢任何帮助！

Answer 1

我认为规范的方法是创建一个_static文件夹，在其中包含CSS文件，然后使用_templates文件夹中的include在模板中引用该CSS。

为了演示这一点，您可以尝试简单覆盖layout.html文件：首先，在docs文件夹中创建_templates（如果它尚不存在），然后创建一个名为{{ 1}}。

使用以下内容填充：

layout.html

一旦你重建了你的文档，你应该看到一个花哨的侧栏和标题。（我在Sphinx / Read The Docs主题implementation中使用了类似的技术。查看源代码等以查看我们覆盖的位数。）

Answer 2

您可以通过向_static添加自定义CSS文件来更改主题颜色。要实际让Sphinx使用该文件，请将其添加到您的conf.py：

def setup(app):
    app.add_css_file('custom.css')

对CSS（custom.css）进行示例以将边栏颜色更改为深绿色（基于@afit的答案）：

.wy-side-nav-search, .wy-nav-top {
    background: #0b750a;
}

Answer 3

添加CSS文件的一种更简单的方法是在conf.py中设置html_css_files：

# custom.css is inside one of the html_static_path folders (e.g. _static)
html_css_files = ["custom.css"]

Answer 4

如果只想更改导航标题的颜色，则可以使用html_theme_options中的conf.py变量来完成。有一个名为'style_nav_header_background'的参数。