2013-01-15 13 views
20

Tôi đang viết một tài liệu và tôi muốn bao gồm các liên kết đến các tệp pdf hoặc lưu trữ zip. Làm thế nào tôi có thể đạt được điều đó bằng ngôn ngữ đầu tiên và nhân sư?Làm thế nào để tạo một liên kết đến một tập tin trong rst với nhân sư?

Nếu tôi làm điều đó

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

Nó không làm việc bởi vì, trong Sphinx biên soạn không sao chép chứa các thư mục doc (tôi sử dụng makefile tạo ra bởi Sphinx-QuickStart).

Ngược lại, sử dụng image chỉ:

.. image:: img/plop.png 

nhân sư không sao chép các hình ảnh plop.png trong xây dựng thư mục. Làm cách nào để có được hành vi tương tự cho bản lưu trữ pdf hoặc zip?

+0

thử vai trò ': download:' - xem http://stackoverflow.com/questions/2921724/include-a-text-file-as-is-in-python-sphinx-docs/ – Bonlenfum

Trả lời

34

Tôi tìm thấy giải pháp trong tài liệu Sphinx:

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

Dưới đây là một ví dụ ngắn giả sử bạn có một tập tin trong một thư mục mypdf.pdfdoc. Thư mục doc và tập đầu tiên của bạn phải nằm trong cùng thư mục:

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

Lưu ý rằng bạn không phải đặt một không gian trống giữa :download: và đường dẫn đến tập tin.

+2

Vui lòng bao gồm giải pháp thực tế. Chỉ cần một ví dụ một dòng là đủ. Câu trả lời chỉ liên kết được khuyến khích trên tràn ngăn xếp: chúng 404 sau một thời gian ngay cả khi bạn trỏ vào tài liệu chính thức :-) –

+4

Tôi đã thêm ví dụ ngắn. – Ger