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自己生成这些指令）。