2017-02-07 3 views
0

J'écris de la documentation dans RST et génère du code HTML avec Sphinx.Modifier la coloration syntaxique dans la documentation RST-Sphinx

Dans les exemples de code, la commande que nous souhaitons que l'utilisateur entre en italique par défaut - est-il possible de mettre ce code en gras?

Par exemple ::

ACOS# this is some text that is currently italics but i would like it to be bold 
+0

J'utilise le texte restructuré à l'auteur et je génère du HTML en utilisant Sphinx 1.4.9. – Ashwin

+0

Le balisage est comme dans la question, il est :: suivi du code. – Ashwin

+0

J'utilise le thème sphinx-rtd. Est-ce que c'est ce qui ajoute les italiques? – Ashwin

Répondre

1

Le caractère # provoque le texte après qu'il soit interprété comme un commentaire. Il est rendu en italique par défaut. La règle CSS est pygments.css (situé dans _static dans le répertoire de sortie):

.highlight .c { color: #408090; font-style: italic } /* Comment */ 

Si vous voulez changer cela en gras, la règle devrait être:

.highlight .c { color: #408090; font-weight: bold } /* Comment */ 

Pour ce faire , vous pouvez le faire comme suit:

  1. Copiez le fichier pygments.css par défaut dans le dossier _static dans votre projet Sphinx.

  2. Modifiez la règle CSS comme ci-dessus.

  3. Régénère la sortie du projet. Votre pygments.css personnalisé sera maintenant utilisé à la place de celui par défaut.


Voici une autre façon de le faire qui fonctionne avec-thème-sphynx Rtd.

  1. Créer un fichier appelé mystyle.css et le mettre dans le répertoire _static de votre projet.

  2. Ajouter cette ligne à conf.py (voir http://www.sphinx-doc.org/en/stable/config.html#confval-html_style):

    html_style = 'mystyle.css' 
    
  3. Ajouter ce qui suit à mystyle.css:

    @import "css/theme.css"; 
    
    .highlight .c { font-weight: bold; font-style: normal } /* Comment */ 
    
+0

J'ai effectué la modification dans le fichier source/_static/pygments.css, mais la police continue d'être en italique. Une fois que j'ai supprimé le hachage, le texte dans le bloc de code change en texte normal. Pouvez-vous s'il vous plaît aider à résoudre les problèmes? – Ashwin

+0

Il semble que sphinx-rtd-theme fonctionne différemment de la plupart des autres thèmes. Il n'utilise pas pygments.css. Voir https://pypi.python.org/pypi/sphinx_rtd_theme#contributing-or-modifying-the-theme. – mzjn

+0

Cela signifie-t-il que nous ne pouvons pas modifier le CSS pour ce thème? – Ashwin