Sphinxの "only"と "ifconfig"の違いは何ですか？

Question

スフィンクスは条件付きコンテンツのための2つのディレクティブを知っている：

• のみ=>http://www.sphinx-doc.org/en/1.4.8/markup/misc.html#tags
• ifconfigコマンド=>http://www.sphinx-doc.org/en/1.4.8/ext/ifconfig.html

をそれらの間の違いは何ですか？

Answer 1

only

onlyディレクティブはtagsに基づいてコンテンツを包含/除外するために使用されます。 tagsを指定することができる。

1. conf.pyで（この使用がifconfigからonlyかなり類似なる）

2. をsphinx-buildに-tフラグを使用-tであるので（makeにフラグとして動作しませんmake用--touchフラグ）

   は

   .. only:: draft 
   
       This message only appears in drafts. 
   

   をexample.rst

   コマンド

   $ sphinx-build -t draft -b html -d _build/doctrees . _build/html 
   

3. 形式やビルダーの名前。 onlyがに輝いています。 .. only:: html内容あなたがmake htmlを使用する場合にのみ内蔵さになるだろうなど

   example.rst

   .. only:: html 
   
       This message only appears in HTML output. 
   

   コマンド

   $ make html 
   

ifconfig

ifconfigは、コンテンツが含まれるようにあなたの柔軟性を提供しますそのtrに基づいてconf.pyに登録された設定変数を含むPythonの式のue-ness。ただし、コンテンツが含まれるか除外されるかを変更するには、conf.pyを編集する必要があります。

結論

あなたのコンテンツが編集conf.pyなしに変更する場合は、onlyをしたいです。 たとえば、onlyを使用してHTMLドキュメントに目次（contentsディレクティブ）を含めますが、私のpdfドキュメントには含まれません（LaTeXは独自のものを作成するため）。