Insert relativer Link in reStructuredText

Question

Ich dokumentiere eine Bibliothek, die eine Python-Komponente und eine JavaScript-Komponente hat. Die gesamte Benutzerdokumentation und die Python-API-Dokumentation befinden sich in reStructuredText und werden mit Sphinx verarbeitet. Die JavaScript-API befindet sich in jsdoc und wird mit jsdoc-toolkit verarbeitet. Das Hauptausgabeformat ist HTML. Ich bin neu bei ReST, Sphinx und Jsdoc.

Ich habe ein Build-System, so dass alle generierten HTML-Seiten in einem einzigen Verzeichnisbaum abgeladen werden eingerichtet. Ich muss nun in die Hauptseite (erzeugt von reST) einen Link zur generierten Javascript Dokumentation einfügen. Dies muss ein relativer Link sein, da sich die Dokumente an verschiedenen Orten in verschiedenen Installationen befinden können. reST analysiert automatisch eine vollständige URL, aber ich kann nicht herausfinden, wie man eine relative Verbindung einfügt. Konstrukte wie :ref: und :doc: scheinen nicht zu helfen, da sie erwarten, dass das Ziel reST ist.

Irgendwelche Ideen?

Answer 1

Ich habe es herausgefunden. Die folgenden Einsätze ein relativer Verweis auf das Dokument js/index.html:

`Javascript API <js/index.html>`_