python-sphinx - software - sphinx significado

¿Cómo hacer un enlace a un archivo en primer lugar con la esfinge?

Question

Estoy escribiendo una documentación y me gustaría incluir enlaces a archivos pdf o archivos zip. ¿Cómo puedo lograr eso usando el primer lenguaje y la esfinge?

Si hago eso

here is a pdf file : `pdf <doc/mypdf.pdf>`_

No funciona porque, durante la compilación, la esfinge no copia los contenidos del directorio doc (yo uso el archivo make generado por sphinx-quickstart).

Por el contrario, utilizando la directiva de image :

.. image:: img/plop.png

sphinx copia la imagen plop.png en el directorio de compilación. ¿Cómo puedo obtener el mismo comportamiento para el archivo pdf o zip?

Answer 1

Encontré la solución en la documentación de la esfinge .

Aquí hay un breve ejemplo que asume que tiene un archivo mypdf.pdf en un doc directorio. El directorio doc y su primer archivo deben estar en el mismo directorio:

here is a pdf file :download:`pdf <doc/mypdf.pdf>`

Tenga en cuenta que no debe poner un espacio en blanco entre :download: y la ruta al archivo.

Answer 2

La directiva de image también funciona para archivos PDF.

.. image:: doc/mypdf.pdf