Ändern Sie die Farben des Sphinx Read The Docs Theme?

Question

Ich baue Dokumentation für meine API-Bibliothek und ich habe readthedocs.io Host die Dokumentation und ist mit Sphinx gesichert. Ich habe das Read The Docs Theme installiert für Sphinx mit pip install, und die Read the Docs-Website hat derzeit die Dokumentation ausgeführt.

Ich möchte die Farben meiner Dokumentation ändern. Ich habe eine Suche in ihrem GitHub-Repository GitHub.com gemacht und habe einige Gespräche gesehen, die die sass Dateien bearbeiten. Ich kann jedoch nicht finden, wo diese Dateien liegen.

Example of a Read The Docs with other colors

Jede Hilfe ist willkommen!

Answer 1

Ich glaube, der kanonische Weg besteht darin, einen _static Ordner zu erstellen, darin CSS-Dateien einzubeziehen und dann auf CSS in Ihren Vorlagen mit einem Include im Ordner _templates zu verweisen.

Um dies zu demonstrieren, können Sie eine einfache Überschreibung der layout.html Datei versuchen: Erstens, erstellen _templates in Ihren Dokumenten-Ordner, wenn es nicht bereits vorhanden ist, dann dort eine Datei namens layout.html erstellen.

dass Bestücken mit den folgenden:

{% 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 %} 

Sobald Sie Ihre Dokumente neu erstellt haben, sollten Sie eine grell Seitenleiste und Header sehen. (Ich verwendete eine ähnliche Technik mit unserem Sphinx/Read The Docs Thema implementation. Sehen Sie Quelle usw. an, um zu sehen, welche Bits wir außer Kraft setzen.)