traduccion - En Python sphinx, cómo enlazar a un archivo en el directorio_static

sphinx traduccion

Question

Tengo algunos ejemplos de código y datos que copio en el directorio _static y me gustaría enlazar a esos archivos en la documentación, algo como:

.. _pca-run.py: _static/example.data

Pero el problema es que la esfinge no crea un enlace relativo adecuado a este archivo, sino que simplemente copia los valores tal como están. Por lo tanto, para los archivos anidados donde _static no se encuentra en el mismo directorio, los enlaces no funcionan.

Answer 1

Lo que quieres es el :download: rol de texto. (como mencionó Mitar en su comentario).

http://www.sphinx-doc.org/en/1.6/markup/inline.html#role-download

El uso de esto le indicará a Sphinx que copie el archivo dado en un directorio "_downloads" y cree un hipervínculo a él. Originalmente fue pensado para ser utilizado para archivos descargables, como quizás archivos PDF (en salida html) o archivos comprimidos, o lo que sea. Sin embargo, funciona bien para cualquier otro archivo que no sea ReST.

Si realmente quisiera, podría escribir una extensión para hacer esto, pero nunca he visto una necesidad, ya que :download: hace exactamente lo que quiero.

Answer 2

Solo encuentre la respuesta correcta a esto para las imágenes : anteponga la ruta del archivo de destino con / . Para imágenes referenciadas desde un automodule

.. image:: some_file.png

se referirá al archivo some_file.png relativo al archivo python que se está procesando actualmente, mientras que

.. image:: /some_file.png

se referirá al archivo some_file.png relativo a la ubicación de conf.py De esta manera, no hay necesidad de contaminar la jerarquía de origen con imágenes.