Wie kann ich in Sphinx einen verknüpfbaren "Terminologie" -Abschnitt ohne großen Overhead erstellen?

8

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.

Gegenwärtig ist das Beste, was ich mir vorstellen kann:

%Vor%

Dann später, in dem anderen Text muss ich tun:

%Vor%

Ich finde die obige Syntax sehr umständlich. Ich weiß, dass ich noch eine weitere Scripting-Ebene oder m4 verwenden könnte, um diese Syntax automatisch zu generieren, aber ich hoffe, dass es einen besseren Weg gibt.

    
Ross Rogers 21.09.2010, 19:02
quelle

1 Antwort

21

Nicht so verschieden, aber Sie können verwenden:

.. Glossar ::

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

: Begriff:

Verweis 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 erklärt wird, erhalten Sie beim Erstellen eine Warnung.

[eingefügt von offizielle Sphinx-Dokumentation]

    
eolo999 29.09.2010, 19:38
quelle