Réutilisation de texte dans RST pour la documentation Sphinx

Question

J'écris de la documentation au format RST et génère du code HTML à l'aide de Sphinx. Je veux pouvoir écrire un paragraphe dans un fichier RST et réutiliser le même paragraphe dans un fichier RST différent dans le même dossier. Je veux la réutilisation telle que si je fais un changement dans le paragraphe original il devrait automatiquement changer dans tous les autres dossiers il a été référencé quand je produis le HTML using Sphinx.

Existe-t-il une syntaxe RST pour que cela se produise? Toute aide est appréciée.

Answer 1

Vous pouvez utiliser le include directive.

Pour inclure de base, référence le paragraphe que vous souhaitez réutiliser comme suit:

Some text 

.. include:: /path/to/file_to_include.rst 

More text 

Dans notre exemple, le contenu de file_to_include.rst est Included text. Sphinx va générer:

Some text 

Included text 

More text 

Comme vous pouvez le voir dans la documentation docutils (lien ci-dessus), vous pouvez spécifier un ensemble d'options, par exemple pour limiter le texte inclus dans une gamme de lignes.