如何用 Sphinx 注释掉 toctree 条目？

Question

我是 Sphinx 的新手，我似乎没有找到实现它的方法。我希望能够随着我的进步快速 comment/uncomment 单个 toctree 条目，而不必删除该行。当我的项目仍在进行时，我曾经在 Latex 中这样做以减少编译时间。

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

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

正确的做法是什么？

Answer 1

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

.. toctree::

    visiblefile1
    visiblefile2

.. toctree::
    :hidden:

    hiddenfile1
    hiddenfile2

另见 sphinx-doc.org。

也许这样可以达到可接受的效果。它不完全是 commenting/uncommenting，但它实现了相同的结果。

Answer 2

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

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

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

有了这个，我可以获得的 'comment/uncomment' 的最佳方法是选择目标行并将其分别拖放到 commented/uncommented 区域。

如何用 Sphinx 注释掉 toctree 条目？

How to comment out a toctree entry with Sphinx?

python-sphinx

toctree