documentation - toctree - restructuredtext tutorial

Insertar enlace relativo en reStructuredText

Question

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, procesado 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.

He configurado un sistema de compilación para que todas las páginas html generadas se vuelquen en un solo árbol de directorios. Ahora necesito insertar en la página principal (generada a partir de reST) un enlace a la documentación de Javascript generada. Este debe ser un enlace relativo, ya que los documentos pueden estar ubicados en diferentes lugares 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 vuelva a aparecer.

¿Algunas ideas?

Answer 1

Lo averigué. Lo siguiente inserta una referencia relativa al documento js/index.html :

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