Dans Sphinx, comment puis-je créer une section "terminologie" lisible sans surcharge massive?

Question

Je veux créer une section "terminologie" avec les définitions des termes que j'utilise de sorte que chaque fois que j'utilise les termes dans cette section de terminologie, un lien est créé qui pointe vers la définition.

Actuellement, le meilleur que je peux imaginer est:

.. |flavor| replace:: `:ref:flavor` 

.. _flavor: 

flavor 
------ 
blah blah blah 

Puis, plus tard, dans l'autre texte que je dois faire:

''' This is a usage of the word |flavor|.''' 

je trouve la syntaxe ci-dessus pour être très lourd. Je sais que je pourrais utiliser encore une autre couche de script ou m4 pour générer automatiquement cette syntaxe, mais j'espère qu'il ya une meilleure façon ..

Answer 1

pas si différent, mais vous pouvez utiliser:

.. glossary ::

Cette directive doit contenir une liste de définitions reST avec des termes et des définitions. Les définitions seront alors référencables avec le rôle 'term'.

: terme:

référence à un terme dans le glossaire. Le glossaire est créé à l'aide de la directive glossaire contenant une liste de définitions avec des termes et des définitions. Il ne doit pas être dans le même fichier que le balisage de terme, par exemple les docs Python ont un glossaire global dans le fichier glossary.rst.

Si vous utilisez un terme qui n'est pas expliqué dans un glossaire, vous recevrez un avertissement pendant la construction.

[collée depuis official sphinx documentation]