web-dev-qa-db-fra.com

Comment faire un lien vers un fichier d’abord avec sphinx?

J'écris une documentation et j'aimerais inclure des liens vers des fichiers pdf ou des archives Zip. Comment puis-je atteindre cet objectif en utilisant la première langue et le sphinx?

Si je fais ça 

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

Cela ne fonctionne pas car, lors de la compilation, sphinx ne copie pas le contenu du répertoire doc (j'utilise le makefile généré par sphinx-quickstart).

Au contraire, en utilisant la directive image:

.. image:: img/plop.png

sphinx copie l'image plop.png dans le répertoire de construction. Comment puis-je obtenir le même comportement pour les archives PDF ou Zip?

29
Ger

J'ai trouvé la solution sur la documentation de sphinx

Voici un court exemple en supposant que vous avez un fichier mypdf.pdf dans un répertoire doc. Le répertoire doc et votre premier fichier doivent se trouver dans le même répertoire:

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

Notez que vous ne devez pas laisser d'espace vide entre :download: et le chemin du fichier.

43
Ger

La directive image fonctionne également pour les fichiers PDF.

.. image:: doc/mypdf.pdf
0
Henrik