8

使用している用語の定義を含む「用語」セクションを作成して、この用語セクションの用語を使用するたびに、その定義を指すリンクが作成されるようにします。

現在、私が考えることができる最高のものは次のとおりです。

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

.. _flavor:

flavor
------
blah blah blah

その後、他のテキストで私はしなければなりません：

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

上記の構文は非常に面倒だと思います。スクリプトまたはm4のさらに別のレイヤーを使用してこの構文を自動生成できることはわかっていますが、もっと良い方法があることを望んでいます。

4

1 に答える 1

23

それほど違いはありませんが、次を使用できます。

.. 用語集::

このディレクティブには、用語と定義を含む reST 定義リストが含まれている必要があります。定義は、'term' ロールで参照可能になります。

：学期：

用語集の用語への参照。用語集は、用語と定義を含む定義リストを含む用語集ディレクティブを使用して作成されます。用語マークアップと同じファイルにある必要はありません。たとえば、Python ドキュメントには、glossary.rst ファイルに 1 つのグローバルな用語集があります。

用語集で説明されていない用語を使用すると、ビルド中に警告が表示されます。

[スフィンクスの公式ドキュメントから貼り付け]

于 2010-09-29T19:38:41.447 に答える