Как я могу добавить ссылки на другие страницы в reStructuredText?

Я использую Sphinx для создания документации для своего проекта, но я изо всех сил пытаюсь понять основные понятия о RST.

Итак, у меня есть базовый проект с index.rst, и я использую sphinx-rtd-theme для его стилизации. Итак, я создал html, и слева у меня есть меню, как здесь . Теперь я создал новую страницу для документации, и первый файл называется auth.rst.

Чего я не понимаю, так это того, как добавить ссылки на другие страницы, такие как auth.rst, в боковое меню слева? Прямо сейчас в этом меню есть две ссылки: Добро пожаловать в документацию Test-API! и Индексы и таблицы. Как мне добавить новые ссылки на другие страницы моей документации? Я не понимаю, где это определено в приведенном ниже коде, и я мало что нашел об этом

Welcome to Test-API's documentation!
================================

.. toctree::
   :maxdepth: 2
   :caption: Contents:



Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`

python python-sphinx restructuredtext
person JayK23    schedule 09.02.2021    source источник

Ответы (1)


arrow_upward
1
arrow_downward

Под ':caption ...' вы пишете относительный путь (откуда этот файл RST находится на диске) к целевому rst (в вашем случае auth.rst)

Пример, учитывая эту структуру папок:

RST
  |- a.rst
  |- b.rst
  |-folder2 
    |-c.rst
    |-d.rst

В a, если бы я хотел сослаться на b и c, я мог бы:

.. toctree::
   :maxdepth: 2
   :caption: Contents:
   b
   folder2/c

И если бы я хотел сослаться на d из c, я бы сделал это в c:

.. toctree::
   :maxdepth: 2
   :caption: Contents:
   d
person CowKeyMan    schedule 09.02.2021