更改Sphinx的颜色阅读文档主题？ [英] Change the colors of the Sphinx Read The Docs theme?

问题描述

我正在为我的API库构建文档，并且已经阅读了thethedocs.io托管文档，并获得了Sphinx的支持。我已经使用 pip install 为Sphinx安装了Read the Docs主题，并且Read the Docs网站当前正在运行该文档。

我想更改文档的颜色。我已经在他们的GitHub存储库中使用了类似的技术。查看源代码等，以了解我们会覆盖哪些位。）

I'm building documentation for my API library and I'm having readthedocs.io host the documentation, and is backed with Sphinx. I have the Read The Docs theme installed for Sphinx using pip install, and the Read the Docs website currently has the documentation running.

I would like to change the colors of my documentation. I have done some searching through their GitHub repository GitHub.com and have seen some talk that editing the sass files. However, I can't seem to find where these files are located.

Any help is appreciated!

解决方案

I believe the canonical way is to create a _static folder, include CSS files in that, and then reference that CSS in your templates with an include in the _templates folder.

To demonstrate this, you can try a simple override of the layout.html file: first, create _templates in your docs folder if it doesn't already exist, then create a file there named layout.html.

Populate that with the following:

{% extends "!layout.html" %}
  {% block footer %} {{ super() }}

  <style>
    /* Sidebar header (and topbar for mobile) */
    .wy-side-nav-search, .wy-nav-top {
      background: #00ff00;
    }
    /* Sidebar */
    .wy-nav-side {
      background: #ff0000;
    }
  </style>
{% endblock %}

Once you've rebuilt your docs, you should see a garish side-bar and header. (I used a similar technique with our Sphinx / Read The Docs theme implementation. View source etc. to see which bits we override.)

这篇关于更改Sphinx的颜色阅读文档主题？的文章就介绍到这了，希望我们推荐的答案对大家有所帮助，也希望大家多多支持IT屋！