2010-11-15 8 views
11

Có cách nào để cài đặt/tạo tài liệu cho các gói được cài đặt bằng pip không?Python pip - cài đặt tài liệu cho các gói?

Tôi muốn cài đặt tất cả các gói cần thiết cho một dự án, cũng như tất cả tài liệu liên quan (ví dụ: tài liệu Django khi cài đặt django, tài liệu dateutil với dateutil, v.v.).

Các tệp yêu cầu đường ống là cách tuyệt vời để cài đặt nhanh gói cần thiết cho dự án, nhưng sẽ tốt hơn nếu tôi cũng có thể cài đặt tất cả tài liệu liên quan.

Gói Debian Python cài đặt tài liệu vào/usr/share/docs, nhưng pip dường như không làm như vậy.

Tài liệu cho các gói này rất quan trọng đối với tôi khi tôi cần làm việc trên các dự án ngoại tuyến.

+0

Tôi không biết tải xuống từ pip nhưng nhiều nhà phát triển hỗ trợ epydoc mà bạn có thể sử dụng để tạo tài liệu tự động. – Joshkunz

Trả lời

4

Tôi nghĩ rằng bạn đang tìm kiếm một tương đương với cách ruby ​​tự động (trừ khi bị đàn áp) tạo ra rdoc từ đá quý/gói đã cài đặt.

Trong python, có một cơ chế chuẩn cho chú thích mã với tài liệu hướng dẫn - docstrings với optional formatting. Tuy nhiên, không có cách thức chuẩn hóa để tạo/lưu trữ tài liệu từ mã python. Mỗi gói python có thể có một cơ chế khác nhau, vì vậy không thể có một cách để pip tạo ra nó.