Как связать/ссылаться на другой файл reST в документации?

Question

У меня просто нет идеи о том, как я могу ссылаться на другой документ в файле reST.

Я хочу связать файл с именем install.rst в моем руководстве по быстрому старту в абзаце. Я не знаю, как я могу это достичь.

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

Док в вопросе: http://todx.rtfd.io

Answer 1

Чтобы referecnce других файлов я должен был включать в себя следующее в conf.py. Я взял код из документов Pillow (PIL fork) here.

extensions = ['sphinx.ext.intersphinx'] 

Я думаю, что расширение между сфинксами пришло мне на помощь. Это связано с другими страницами документа.

Answer 2

Чтобы создать ссылки между различными файлами reStructuredText (.rst), вы можете использовать встроенную разметку, предоставленную сфинксом. See the documentation под заголовком перекрестных ссылок документов

в верхней части файла, определить его метку

.. _my-reference-label: 

, то вы можете связать его с другими документами с использованием

:doc:`my-reference-label`. 

Я не что вам нужно использовать расширение interphinx, поскольку оно предназначено для связей между различными проектами. С помощью этого метода вы можете связывать между различными .rst-файлами, используя их относительные пути, как описано в ссылке documentaion выше.