python-sphinx - 在 Sphinx 中包含另一个页面的 ToC

Question

我在 plugins/index.html 有以下页面：

Plugin Development
==================

.. toctree::
   :hidden:

   basics/index
   advanced/index


The Basics
----------

- :doc:`basics/gettingstarted`
- :doc:`basics/resources`
- :doc:`basics/i18n`


Advanced Topics
---------------

- :doc:`advanced/models`
- :doc:`advanced/controllers`
- :doc:`advanced/services`

plugin/basics/index.html 和 plugins/advanced/index.html 包含它们自己的目录树，它们链接到 plugins/index.html 中列出的相同子页面。所以我想知道的是，有没有办法只包括那些子目录树，而不是像我一样手动列出子页面？

我意识到我可以从目录树中删除 :hidden: 标志，但关键是我想将基本/高级主题保留在单独的列表中，并带有它们自己的标题、介绍段落等。

Answer 1

您可以像这样列出整个目录内容（或这些指令的各种组合）：

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

  **

或者我也认为这样（未经测试）：

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

  *
  basics/*
  advanced/*

但是，我发现手动列出内容通常是最好的方法。虽然自动生成的 TOC 很好，但它们在格式方面没有给您太多空间（例如，创建子标题和更改页面顺序等）。

在我们的文档中，我所做的与您在最初的问题中所做的几乎相同。