python - Sphinx-toctree和content有什么区别？

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

.. contents::
   :local:
   depth: 1

或作为

.. toctree::
    :maxdepth: 1

    index

有什么区别？我应该在哪里使用toctree以及其中的内容？

最佳答案

.. 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不需要。

关于python - Sphinx-toctree和content有什么区别？，我们在Stack Overflow上找到一个类似的问题：https://stackoverflow.com/questions/39768133/