In Sphinx, wie kann ich eine verknüpfbare "Terminologie" -Abschnitt ohne großen Aufwand erstellen?

Question

Ich möchte einen "Terminologie" -Abschnitt mit Definitionen für die von mir verwendeten Begriffe erstellen, sodass jedes Mal, wenn ich die Begriffe in diesem Terminologieabschnitt verwende, eine Verknüpfung erstellt wird, die auf die Definition verweist.

Derzeit ist die beste, die ich denken kann, bis ist:

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

.. _flavor: 

flavor 
------ 
blah blah blah 

Dann später im anderen Text, den ich zu tun haben:

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

ich die obige Syntax finden sehr umständlich. Ich weiß, dass ich noch eine weitere Schicht von Skript- oder m4 verwenden, könnte diese Syntax-auto generieren, aber ich hoffe, es gibt einen besseren Weg ..

Answer 1

nicht so anders, aber Sie verwenden können:

.. Glossar ::

Diese Direktive eine reST Definitionsliste mit Begriffen und Definitionen enthalten. Die Definitionen können dann mit der Rolle "Begriff" referenziert werden.

: term:

Referenz auf einen Begriff im Glossar. Das Glossar wird mithilfe der Glossardirektive erstellt, die eine Definitionsliste mit Begriffen und Definitionen enthält. Es muss sich nicht in der gleichen Datei wie der Markup befinden, zum Beispiel haben die Python-Dokumente ein globales Glossar in der Datei glossary.rst.

Wenn Sie einen Begriff verwenden, der nicht in einem Glossar erläutert wird, erhalten Sie beim Erstellen eine Warnung.

[klebte von official sphinx documentation]