如何用 Sphinx 注释掉一个 toctree 条目？

问题描述

我是 Sphinx 的新手，我似乎没有找到实现这一目标的方法。我希望能够随着我的进展快速评论/取消评论单个 toctree 条目，而不必删除该行。我过去常常在 Latex 中执行此操作，以在我的项目仍在进行中时减少编译时间。

例如，我想实现这样的目标：

.. toctree::
   
   file1
   file2
   .. file3   (I want to comment/uncomment this,easily)
   file4
   ..  file5  (this also fails)
   ..
       file6  (this also fails)

正确的做法是什么？

解决方法

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

.. toctree::

    visiblefile1
    visiblefile2

.. toctree::
    :hidden:

    hiddenfile1
    hiddenfile2

另见sphinx-doc.org。

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

看来我可能找到了接近解决方案的东西（迄今为止最接近的）。它包括将 .. 不缩进，即与 toctree 指令处于同一级别。例如，我得到这样的东西：

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

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

有了这个，我能得到的“评论/取消评论”的最佳方法是分别选择目标行并将其拖放到评论/取消评论区域。

python-sphinx toctree