Aller au contenu

Créer des documents différents à partir des mêmes sources ReST (texte conditionnel)

  1. Installez Sphinx, et make :

    Fenêtre de terminal
    sudo apt install python3-sphinx make
  2. Créez un projet Sphinx en appliquant tous les choix par défaut :

    Fenêtre de terminal
    sphinx-quickstart
  3. Ajoutez le contenu suivant au fichier index.rst en respectant bien les indentations :

    .. only:: electrician
    .. admonition:: Danger pour les électriciens
    Risque d'électrocution
    Ne touchez pas les fils électriques.
    .. only:: plumber
    .. admonition:: Danger pour les plombiers
    Risque de noyade
    Ne plongez pas dans la piscine.
  4. Pour masquer ou non le contenu destiné aux électriciens ou aux plombiers, commentez ou non les lignes suivantes du fichier de configuration conf.py :

    tags.add('electrician')
    tags.add('plumber')
  5. Générez votre contenu :

    Fenêtre de terminal
    make html
  6. Ouvrez le fichier _build/html/index.html sous un navigateur pour visualiser votre contenu.