Python sphinx 如何用Sphinx注释出目录树条目？

我是斯芬克斯的新手，我似乎没有找到实现这一点的方法。我希望能够在进程中快速注释/取消注释单个目录树条目，而无需删除该行。我经常在Latex中这样做，以减少项目仍在进行时的编译时间

例如，我想实现如下目标：

.. toctree::
   
   Title 1 <file1>
   Title 2 <file2>
   Title 4 <file4>

.. the comment starts here
   Title 3 <file3>
   Title 5 <file5>
   etc

。。目录树：：
文件1
文件2
.. 文件3（我想简单地对此进行注释/取消注释）
文件4
..  文件5（这也会失败）
..
文件6（这也会失败）

---

正确的方法是什么？

您是否尝试过在toctree指令下使用：hidden:选项？ 我认为您需要有两个单独的toctree指令来实现这一点：

.. toctree::

    visiblefile1
    visiblefile2

.. toctree::
    :hidden:

    hiddenfile1
    hiddenfile2

另见

---

也许这能达到可以接受的结果。这并不完全是注释/取消注释，但它实现了相同的结果。

似乎我已经找到了接近解决方案的东西（目前为止最接近的）。它包括将

。

放在不包含的位置，即与

目录树

指令处于同一级别。例如，我得到了如下结果：

.. toctree::
   
   Title 1 <file1>
   Title 2 <file2>
   Title 4 <file4>

.. the comment starts here
   Title 3 <file3>
   Title 5 <file5>
   etc

。。目录树：：
标题1
标题2
标题4
.. 评论从这里开始
标题3
标题5
等

---

有了这一点，我能得到的最好的“注释/取消注释”方法是选择目标行，然后分别将其拖放到注释/取消注释区域。

这对我来说很有效。我刚刚得到一个警告：

警告：toctree包含对不存在文档的引用“。。文件3'

，并生成文档。如果你仍然看到一个构建的页面，那么你首先需要

make clean

来删除最初构建的文件。是的，我注意到了这一点，但一方面我认为这不是真正的解决方案（因为我可以得到许多警告，使我的编译输出不整洁），但更重要的是，当使用自定义标题时（例如

Title 3

）那么它就根本不起作用了。它将编译文档文件3（这是我想要避免的），并在生成的html上将链接显示为“.Title 3”。不幸的是：hidden:选项不会跳过编译，它只会在doctree中隐藏链接（如果我想手动添加链接）。但是Sphinx仍然编译文档，如果我键入它们的URL，它们肯定是可以访问的。因此，编译时间不会减少，这是我的目标，在大型项目中尤其重要。无论如何谢谢你！