6

.. glossary::Sphinx 1.1.3 を使用している場合、自動生成されたインデックスに表示されないエントリを作成するにはどうすればよいですか?

:noindex:私は4つの場所で試しました：

用語集の前後は、用語集を非表示にします。

.. :noindex: glossary:: 

    `term`
        definition

.. glossary:: :noindex:

    `term`
        definition

用語と一緒に置くと、用語をクリック可能になり、 が表示されます:noindex:。

.. glossary:: 

    :noindex: `term`
        definition

.. glossary:: 

    `term` :noindex:
        definition

私の用語には特殊文字が含まれているため、意図的にバッククォートで囲んでいます。

4

1 に答える 1

2

私が理解しているように、glossaryディレクティブは、ドキュメントのどこからでも簡単に参照できる用語ごとにフックを作成します。そしてそれは、ビルド時に少なくとも内部的に、どこかのインデックスになります。

これを回避するには、定義の標準リストを使用できます。

 term_1
   definition for term_1

 term_2
   definition for term_2

これらの定義はローカルにのみ書き込まれ、メイン インデックスには表示されません。構文の詳細については、reST ドキュメントを参照してください。

そのようなリストにいくつかの用語を明示的に含めたい場合は、:index:ロールを使用できます。

 :index:`term_3`
   definition for an indexed term

これらの用語がインデックスに表示されるようになります。ただし、非常に少数の用語でない限り、これはグロッサリーが行うことを達成するための扱いにくい方法です。相互参照を使用する機能を失います (構文を使用:term:`term_1`)。

于 2013-01-15T11:19:49.687 に答える