2010-09-02 5 views
22

Je documente une bibliothèque qui a un composant Python et un composant JavaScript. La documentation utilisateur globale et la documentation de l'API Python se trouvent dans reStructuredText, traité avec Sphinx. L'API JavaScript est dans jsdoc et est traitée avec jsdoc-toolkit. Le format de sortie principal sera HTML. Je suis nouveau sur reST, Sphinx et jsdoc.Insérer un lien relatif dans reStructuredText

J'ai mis en place un système de construction pour que toutes les pages html générées soient déversées dans une seule arborescence de répertoires. Je dois maintenant insérer dans la page principale (générée à partir de reST) un lien vers la documentation Javascript générée. Cela doit être un lien relatif, car les documents peuvent être situés à différents endroits sur différentes installations. reST analysera automatiquement une URL complète, mais je n'arrive pas à comprendre comment insérer un lien relatif. Constructions comme :ref: et :doc: ne semblent pas aider, car ils s'attendent à ce que la cible soit reST.

Des idées?

Répondre

28

Compris. Les inserts suivants une référence par rapport au document js/index.html:

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

À moins que vous cherchez toujours une meilleure réponse, vous devez accepter votre propre réponse. De cette façon, les personnes qui trouvent votre question dans une recherche peuvent voir qu'elle a une réponse correcte. –

+0

J'ai oublié que je ne l'avais pas encore accepté. –

+0

Cette référence vous sera utile: http://hyperpolyglot.org/lightweight-markup – Javier

Questions connexes