Вставить относительную ссылку в reStructuredText

Я документирую библиотеку, в которой есть компонент Python и компонент JavaScript. Общая пользовательская документация и документация API Python находятся в reStructuredText, обработанном с помощью Sphinx. JavaScript API находится в jsdoc и обрабатывается с помощью jsdoc-toolkit. Основным форматом вывода будет HTML. Я новичок в reST, Sphinx и jsdoc.

Я настроил систему сборки, чтобы все сгенерированные html-страницы сбрасывались в одно дерево каталогов. Теперь мне нужно вставить на главную страницу (сгенерированную из reST) ссылку на сгенерированную документацию по Javascript. Это должна быть относительная ссылка, поскольку документы могут находиться в разных местах на разных установках. reST автоматически проанализирует полный URL-адрес, но я не могу понять, как заставить его вставить относительную ссылку. Такие конструкции, как :ref: и :doc: не помогает, потому что они ожидают, что цель будет reST.

Любые идеи?


person Dan Menes    schedule 02.09.2010    source источник


Ответы (1)


Догадаться. Далее вставляется относительная ссылка на документ js/index.html:

`Javascript API <js/index.html>`_
person Dan Menes    schedule 02.09.2010
comment
Если вы все еще не ищете лучший ответ, вы должны принять свой собственный ответ. Таким образом, люди, которые найдут ваш вопрос в поиске, увидят, что на него есть правильный ответ. - person Geoff Reedy; 20.09.2010
comment
Эта ссылка будет полезна: hyperpolyglot.org/lightweight-markup - person Javier; 04.03.2018