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)

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

我试图将一个或多个.. 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的一部分中这样做，虽然我们也是通配的，因为文件的顺序并不重要。您的订单似乎很重要，因此必须按所需顺序列出它们。