2017-06-28 1 views
3

Je construis la documentation pour ma bibliothèque d'API et Readthedocs.io héberge la documentation, et est soutenu par Sphinx. J'ai le thème Read the Docs installé pour Sphinx en utilisant pip install, et le site Web de Read the Docs a actuellement la documentation en cours d'exécution.Modifier les couleurs du thème Sphinx Read The Docs?

Je voudrais changer les couleurs de ma documentation. J'ai fait quelques recherches à travers leur dépôt GitHub GitHub.com et j'ai vu parler que l'édition des fichiers sass. Cependant, je n'arrive pas à trouver où se trouvent ces fichiers.

Example of a Read The Docs with other colors

Toute aide est appréciée!

Répondre

1

Je crois que la façon canonique est de créer un dossier _static, y inclure des fichiers CSS, puis de faire référence à ce CSS dans vos modèles avec une inclusion dans le dossier _templates.

Pour démontrer cela, vous pouvez d'un simple remplacement du fichier layout.html: d'abord, créez _templates dans votre dossier docs si elle n'existe pas encore, puis créez un fichier nommé il layout.html.

que POPULATE ce qui suit:

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

Une fois que vous avez rebâti vos documents, vous devriez voir une criardes barre latérale et en-tête. (J'ai utilisé une technique similaire avec notre thème Sphinx/Read The Docs implementation. Voir la source etc. pour voir quels bits nous avons remplacés.)