2010-09-02 16 views
22

Estoy documentando una biblioteca que tiene un componente de Python y un componente de JavaScript. La documentación general del usuario y la documentación de la API de Python están en reStructuredText, procesados ​​con Sphinx. La API de JavaScript está en jsdoc y se procesa con jsdoc-toolkit. El formato de salida principal será HTML. Soy nuevo en reST, Sphinx y jsdoc.Insertar enlace relativo en reStructuredText

He configurado un sistema de compilación para que todas las páginas html generadas se almacenen en un solo árbol de directorios. Ahora necesito insertar en la página principal (generada desde reST) un enlace a la documentación Javascript generada. Esto debe ser un enlace relativo, ya que los documentos pueden estar ubicados en lugares diferentes en diferentes instalaciones. reST analizará automáticamente una URL completa, pero no puedo averiguar cómo hacer que inserte un enlace relativo. Las construcciones como :ref: y :doc: no parecen ayudar, porque esperan que el objetivo sea reST.

¿Alguna idea?

Respuesta

28

Lo descubrí. Los siguientes inserta una referencia relativa al documento js/index.html:

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

A menos que esté todavía en busca de una respuesta mejor, usted debe aceptar su propia respuesta. De esta forma, las personas que encuentran su pregunta en una búsqueda pueden ver que tiene una respuesta correcta. –

+0

Olvidé que aún no había aceptado. –

+0

Esta referencia será útil: http://hyperpolyglot.org/lightweight-markup – Javier

Cuestiones relacionadas