Как сделать ссылку на файл сначала с помощью sphinx?

Я пишу документацию, и я хотел бы включить ссылки на pdf файлы или архивы zip. Как я могу достичь этого, используя первый язык и сфинкс?

Если я делаю это

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

Это не работает, потому что во время компиляции sphinx не копирует содержимое каталога doc (я использую make файл, сгенерированный с помощью sphinx-quickstart).

Наоборот, с помощью директивы image:

.. image:: img/plop.png

sphinx копирует образ plop.png в каталог сборки. Как я могу получить такое же поведение для архива в формате pdf или zip?

Ответы

Ответ 1

Я нашел решение в документации sphinx:

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

Вот краткий пример, предполагающий, что у вас есть файл mypdf.pdf в каталоге doc. Каталог doc и ваш первый файл должны находиться в одном каталоге:

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

Обратите внимание, что вы не должны помещать пробел между :download: и путём к файлу.