将所有 :glob:-discovered 文件折叠到一个 TOC 条目中

Question

我有这样的东西：

.. toctree::
   :maxdepth: 2
   :caption: Contents:
   :hidden:
   :glob:

   docs
   frontend
   backend
   tools/*

我希望在 tools 目录中找到的所有文档都折叠成一个可扩展的 sidebar TOC 条目。应该可以，但我找不到线索。

我用sphinx_rtd_theme.

换句话说：假设我有一个很长的文档，像这样 (tools.rst):

Section 1
*********

Subsection 1
============

Subsection 2
============

Subsection 3
============

我应该如何按小节拆分它并保留文档结构，而不求助于 include，无论如何它都不适合 Sphinx。

Answer 1

source/index.rst:

.. toctree::
   :maxdepth: 2
   :caption: Contents:
   :glob:

   tools/_tools
   docs
   frontend
   backend
   tmp/*

旧source/tools/_tools.rst:

Notes on tools
**************

.. include:: black.rst
.. include:: docker.rst
.. include:: git_hooks.rst
.. include:: github_webhooks.rst
.. include:: mypy.rst
.. include:: pipm.rst
.. include:: poetry.rst
.. include:: sphinx.rst
.. include:: uvicorn.rst

新 source/tools/_tools.rst:

Notes on tools
**************

.. toctree::
   :maxdepth: 2
   :glob:

   *

新的渲染与旧的完全一样，而且更通用，更干净。