Sphinx - Générer des documents internes et externes à partir d'une source unique

Question

J'essaie de trouver des informations sur la capacité de Sphinx à étiqueter certains éléments de la documentation comme étant 'internes' et de les construire comme sphinx-build -b -include internal source output où le drapeau -include contiendrait une série d'étiquettes à inclure dans la sortie.

Cela me permettrait de générer 2 versions (ou plus) de mes documents tout en conservant la source unique.

Exemple:

.. audience::internal 

Page title 
============ 

This whole page will be available only in the internal docs. 

ou

Page title 
============ 

This whole page will be available in the internal and external docs. 

.. audience::internal 

That p will only be available in the internal docs. 

This p will be available in the internal and external docs. 

Y at-il un tel mécanisme? Si non, cela serait-il difficile à créer?

Answer 1

ifconfig est une façon de le faire en effet, mais après avoir demandé autour, il semble qu'il y ait un meilleur mécanisme:

.. only:: directive

Utilisez-le pour marquer quelque chose:

.. only:: internal 

    Page title 
    ============ 

    This whole page will be available only in the internal docs. 

Ensuite, vous pouvez exécuter une build avec l'option -t pour publier tout marqué avec internal (ou ce que vous avez utilisé)

sphinx-build -t internal -b html source output 

J'espère que cela aidera les autres.

Answer 2

L'extension Sphinx ifconfig peut faire ce que vous voulez, bien que vous deviez indenter le contenu.