在Sphinx reST中包含保密信息

时间:2011-11-18 04:05:54

标签: python python-sphinx restructuredtext

我在自己的“copy.rst”文档中有保密文本。如果没有出现在toctree中我怎么能包括它呢?

2 个答案:

答案 0 :(得分:3)

正确的方法是

  1. 请勿在{{1​​}}中添加copy.rst。这样,此页面不会出现在下一个/上一个页面。

  2. .. toctree:写入:orphan:的第一行。这样您就不会看到任何编译器警告。

答案 1 :(得分:1)

使用:hidden:选项将copy.rst添加到单独的toctree:

.. toctree::

   doc1.rst 
   doc2.rst

.. toctree::
   :hidden:

   copy.rst   

你也可以什么都不做(只需将copy.rst与其他.rst文件保持一致)并简单地忽略“copy.rst :: WARNING:文档不包含在任何toctree中”消息。