2013-01-15 10 views
20

Piszę dokumentację i chciałbym dołączyć linki do plików pdf lub archiwów zip. Jak mogę to osiągnąć używając pierwszego języka i sfinksa?Jak zrobić łącze do pliku w pierwszej kolejności z Sfinksem?

Gdybym zrobić

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

To nie działa, ponieważ podczas kompilacji sfinks nie kopiować materiały zawarte w katalogu doc ​​(używam makefile generowane przez Sfinks-QuickStart).

Wręcz przeciwnie, za pomocą dyrektywy image:

.. image:: img/plop.png 

sfinks nie kopiować obraz plop.png w katalogu build. Jak uzyskać to samo zachowanie dla archiwum pdf lub zip?

+0

Wypróbuj rolę ': download:' - zobacz http://stackoverflow.com/questions/2921724/include-a-text-file-as-is-in-python-sphinx-docs/ – Bonlenfum

Odpowiedz

34

znalazłem rozwiązanie w dokumentacji Sfinks:

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

Oto krótki przykład zakładając, że masz plik mypdf.pdf w katalogu doc. Katalog doc i plik najpierw musi być w tym samym katalogu:

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

pamiętać, że nie musi umieścić spację między :download: i ścieżkę do pliku.

+2

Proszę uwzględnić rzeczywiste rozwiązanie. Wystarczy jeden wiersz. Odpowiedzi dotyczące linków są zniechęcane do przepełnienia stosu: po chwili 404, nawet jeśli wskażesz oficjalne dokumenty :-) –

+4

Dodałem krótki przykład. – Ger