在 Sphinx reST 中包含机密信息

Question

我在其自己的“copy.rst”文档中有保密文本。如何将其包含在目录树中而不显示出来？

Answer 1

使用 :hidden: 选项将 copy.rst 添加到单独的目录树中：

.. toctree::

   doc1.rst 
   doc2.rst

.. toctree::
   :hidden:

   copy.rst   

您也可以什么都不做（只需将 copy.rst 与其他 .rst 文件一起保留）并忽略“copy.rst::警告：文档不包含在任何目录树中”消息。

Answer 2

正确的方法是

1. 不要在任何.. toctree:中包含copy.rst。这样，该页面就不会出现在下一个/上一个页面中。

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