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中的分层文档

1 个答案: