Quelle est la meilleure façon d'inclure un PDF dans ma documentation Sphinx?

Question

J'ai un PDF qui a une explication détaillée d'un exemple dans la documentation de Sphinx pour un paquet que j'ai. Y a-t-il un moyen d'inclure facilement le PDF dans mon projet (et de le faire copier lorsque je compilerai les documents)? J'ai essayé de le lier avec: doc: mais cela ne l'a pas copié.

Answer 1

Utilisez le rôle de texte :download: pour ajouter un fichier supplémentaire arbitraire. Donc, dans votre cas, vous pourriez faire quelque chose comme ceci:

For an in-depth explanation, please see :download:`A Detailed Example <some_extra_file.pdf>`.