2010-02-07 13 views
19

J'écris de la documentation avec Sphinx et je voudrais imprimer un certain bloc de texte uniquement pour la documentation HTML, pas pour la documentation LaTeX. Quelque chose me dit que je devrais être capable de le faire avec sphinx.ext.ifconfig mais je n'arrive pas à comprendre comment. Est-ce que quelqu'un sait comment faire ça?Sortie conditionnelle dans Sphinx Documentation

Répondre

25

Aucune extension n'est requise. Utilisez simplement le only directive. Cela fonctionne comme ceci:

 
.. only:: latex 

    The stuff in here only appears in the latex output. 

.. only:: html 

    The stuff in this block only appears in the HTML output. It's 
    often useful to use this directive with it: 

    .. raw:: html 

     It's good for embedding stuff, like video. 
+0

Est-il possible de discerner entre 'singlehtml' et' html'? – Carel

+0

@Carel Oui, avec Sphinx 1.2 et versions ultérieures, vous pouvez distinguer 'html' et' singlehtml' en utilisant les balises de constructeur explicites 'builder_html' et' builder_singlehtml'. – ddbeck

+0

pourriez-vous s'il vous plaît jeter un oeil à une question similaire. http://stackoverflow.com/questions/42798152/adding-custom-tag-in-sphinx – Learner