在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包含自己的toctree,它们链接到plugins/index.html中列出的相同子页面.所以我想知道的是,有没有办法只包括那些子toctree,而不是像我一样手动列出子页面？

我意识到我可以从toctree中删除:hidden:标志,但重点是我想将Basic/Advanced主题保存在单独的列表中,并带有自己的标题,介绍段落等.

Answer 1

您可以列出这样的整个目录内容(或这些指令的各种组合):

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

  **

或者我认为也是这样(未经测试):

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

  *
  basics/*
  advanced/*

但是,我发现只需手动列出东西往往是最好的方法.虽然自动生成的TOC很不错,但它们在格式化方面不会占用太多空间(例如,创建子标题,更改页面顺序等).

在我们的文档中,我在初始问题中做了几乎相同的事情.