Frage

Ich dokumentieren eine Bibliothek, die eine Python-Komponente und eine JavaScript-Komponente hat. Die gesamte Benutzerdokumentation und die Python-API-Dokumentation ist in reStructuredText, mit Sphinx verarbeitet. Der JavaScript-API ist in jsdoc und ist mit jsdoc-Toolkit verarbeitet. Das Hauptausgabeformat HTML sein. Ich bin neu in Ruhe, Sphinx und jsdoc.

Ich habe ein Build-System, so dass alle generierten HTML-Seiten werden in einen einzigen Verzeichnisbaum abgeladen einrichten. Ich muß jetzt in die Haupt Seite einzufügen (erzeugt aus reST) einen Link zu der generierten Javascript-Dokumentation. Dies muss ein relativer Link sein, da die Dokumente in verschiedenen Orten auf verschiedenen Installationen befinden. reST wird automatisch eine vollständige URL analysieren, aber ich kann nicht herausfinden, wie es einen relativen Link zu machen einzufügen. Konstrukte wie : ref: und : doc:. scheint nicht zu Hilfe, weil sie das Ziel erwarten reST sein

Irgendwelche Ideen?

War es hilfreich?

Lösung

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

`Javascript API <js/index.html>`_
Lizenziert unter: CC-BY-SA mit Zuschreibung
Nicht verbunden mit StackOverflow
scroll top