狮身人面像 - toctree和内容之间有什么不同？

Question

我可以通过两种方式创建目录：

.. contents::
   :local:
   depth: 1

或

.. toctree::
    :maxdepth: 1

    index

有什么区别？我应该在哪里使用toctree和内容？

Answer 1

.. contents是doctutils指令（定义ReST和相关实用程序的基础库）， 自动 从当前主题的标题生成目录

.. toctree是一个Sphinx定义的指令，您可以在其中明确列出其TOC将被列出的文档。

您可以在文档中使用.. contents来生成页面内容的概述，例如：

===================
Curing World Hunger
===================

.. contents::
   :depth: 1

Abstract
========

…

Problem description
===================

…

您在索引文档中使用.. toctree，其中基本上不包含任何内容：

=================
Scientific papers
=================

Below is a list of papers published here:

.. toctree::
   :maxdepth: 2

   curing_hunger
   …

.. toctree会收集要处理的文档列表，.. contents没有。