2013-01-15 7 views
20

Sto scrivendo una documentazione e vorrei includere collegamenti a file pdf o archivi zip. Come posso ottenerlo usando il primo linguaggio e la sfinge?Come fare un collegamento a un file prima con la sfinge?

Se lo faccio

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

Non funziona perché, durante la sfinge di compilazione non copiare la contiene delle directory doc (io uso il makefile generato da sfinge-quickstart).

Al contrario, usando la direttiva image:

.. image:: img/plop.png 

sfinge non copiare l'immagine plop.png nella directory di compilazione. Come posso ottenere lo stesso comportamento per l'archivio pdf o zip?

+0

provare il '' download: 'role - consultare http://stackoverflow.com/questions/2921724/include-a-text-file-as-is-in-python-sphinx-docs/ – Bonlenfum

risposta

34

Ho trovato la soluzione nella documentazione sfinge:

http://sphinx-doc.org/markup/inline.html#referencing-downloadable-files

Ecco un breve esempio supponendo che si dispone di un file in una directory mypdf.pdfdoc. La directory doc e il file prima devono essere nella stessa directory:

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

Notare che non è necessario inserire uno spazio vuoto tra :download: e il percorso del file.

+2

Si prega di includere il soluzione reale. Basta un esempio di una sola riga. Le risposte al solo link sono scoraggiate nello stack overflow: 404 dopo un po 'anche se punti ai documenti ufficiali :-) –

+4

Ho aggiunto il breve esempio. – Ger

Problemi correlati