Sphinx的「唯一」和「ifconfig」指令有什麼區別？

Question

獅身人面像知道有條件的內容兩條指令：

• 只=>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（這使得使用非常only類似ifconfig）

2. 使用-t標誌sphinx-build（不作爲一個標誌，因爲-t是工作make--touch標誌make）

   example.rst

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

   命令

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

3. 格式或助洗劑的名稱。 這是only閃耀。當您使用make html等

   example.rst

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

   命令

   $ make html 
   

ifconfig

ifconfig給你的靈活性，包括內容.. only:: html內容只會得到建基於tr包含在conf.py中註冊的配置變量的任何Python表達式的用法。這意味着，但是，您必須編輯conf.py以更改是否包含或排除內容。

結論

如果你想你的內容更改，恕不編輯conf.py你想only。 例如，我使用only在我的HTML文檔中包含目錄（contents指令），但在我的pdf文檔中沒有（因爲LaTeX自己生成這些指令）。