Иерархическая документация в Sphix - PullRequest
Новая
       0

Иерархическая документация в Sphix

0 голосов
/ 13 февраля 2019

Я пытаюсь создать иерархическую документацию в Сфинксе.

Мне нужна следующая структура: 

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:: в верхний индексный файл, но результаты выглядят довольно случайными.

1 Ответ

0 голосов
/ 13 февраля 2019

Создайте структуру каталогов и файлов, которая соответствует следующим записям 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

Мы делаем это в части Документация по пирамиде , хотя мы также занимаемся глобализацией, потому что порядок файлов не важен.Ваш заказ имеет важное значение, поэтому необходимо перечислить их в желаемом порядке.

...