Sphix 中的分层文档

Question

我正在尝试在 Sphinx 中生成分层文档。

我想要以下结构：

Introduction
Quick start
Weather API (one general page + 2 subpages)
  Temperature
  Humidity
Sky API (one general page + 3 subpages)
  Planets
  Stars
  Satellites
Future API (one page is enough for this)

假设上述目录中每一行都有一个文件，我应该怎么做才能实现这一目标？

我试图将一个或多个 .. toctree:: 指令包含到顶部索引文件中，但结果似乎非常随机。

Answer 1

创建与以下 toctree 条目对齐的目录和文件结构，但实际文件名附加 .rst 后缀。

.. toctree::

    introduction
    quick_start
    weather_api/index
    weather_api/temperature
    weather_api/humidity
    sky_api/index
    sky_api/planets
    sky_api/stars
    sky_api/satellites
    future_api/index

我们在 Pyramid's documentation 的一部分中执行此操作，尽管我们也会进行通配，因为文件的顺序并不重要。您的订单似乎很重要，因此有必要按照您想要的顺序列出它们。

Sphix 中的分层文档

Hierarchical documentation in Sphix

python-sphinx

toctree