2010-01-25 19 views
15

Chỉ là tôi, hoặc tài liệu thư viện chuẩn python là cực kỳ khó khăn để duyệt qua?Cách khác để duyệt qua trăn api

Java có của nó rực rỡ Javadocs, Ruby có hữu ích Ruby-Docs, chỉ trong python tôi không thể tìm thấy một cách tốt đẹp của nó để di chuyển qua các tài liệu thư viện chuẩn.

Có dự án Epydoc, trông đẹp, nhưng có ai biết nếu nó thực sự đang được sử dụng trên thư viện chuẩn, vì vậy tất cả chúng ta có thể đi qua nó? Nếu không, các lựa chọn thay thế mà mọi người đang sử dụng để duyệt tài liệu python là gì.

+5

Python và nhiều thư viện lớn sử dụng Nhân sư cho tài liệu. Từ quan điểm khả năng sử dụng, các tài liệu được tạo ra khá khủng khiếp (mặc dù chúng sử dụng một số CSS đẹp mắt). Một ví dụ cho rằng đó là những trang cực kỳ dài, làm cho việc duyệt web trở nên rất khó khăn. – nikow

+3

Wow ... Python có thể không phải là tài liệu tuyệt vời nhất, nhưng so sánh nó không thuận lợi với * javadoc *? Doc là khá nhiều điều yêu thích nhất của tôi về Java: bạn thường có một hướng dẫn nhỏ và sau đó chỉ có javadoc: một mê cung vô dụng về lớp và các chi tiết kỹ thuật của phương pháp mà không có hướng dẫn để tìm cách sắp xếp mọi thứ và những gì bạn ' dự kiến ​​sẽ sử dụng. – bobince

+7

Tôi tìm thấy javadocs là một công cụ tuyệt vời để duyệt qua các API. Chất lượng của tài liệu không phải là trách nhiệm của công cụ, mà là của tác giả tài liệu. Vì vậy, IMHO, có, javadocs là tốt hơn nhiều so với những gì các trang web tài liệu python chính thức đang sử dụng. – ivo

Trả lời

8

Tôi thường sử dụng được xây dựng trong pydoc, nếu bạn đang ở trên cửa sổ, nó sẽ được gọi là Tài liệu mô-đun nếu bạn đang sử dụng linux pydoc -p 8000 và kết nối thông qua trình duyệt.

2

bạn có thể truy cập here và tải xuống phiên bản chm của Python 3.1. Với điều đó, tìm kiếm thông qua các tài liệu nên dễ dàng.

3

pydoc từ dòng lệnh, help() từ lời nhắc thông dịch viên tương tác.

3

pydoc -p 8080

Cộng đồng python là semi-thù địch để tự động tạo ra các tài liệu, đặc biệt nếu đó là đối tượng Định hướng. Python không chỉ hướng đối tượng (đó là một ngôn ngữ đa mô hình), vì vậy các nhà phát triển Python thường thích tài liệu hướng dẫn bằng văn bản của con người. Đôi khi các chức năng rất quan trọng, đôi khi cấu trúc Lớp là quan trọng.

+0

Vâng, tôi đã nếm trải một số sự thù địch ... – ivo

0

Tôi đã từng sử dụng số python sidebar từ Edgewall một thời gian dài trước đây.

Những ngày này, tôi google cho hàm python (tài liệu chuẩn hầu như luôn hiển thị dưới dạng liên kết đầu tiên). Nếu tôi muốn duyệt nguồn của mô-đun (hữu ích đôi khi), tôi sử dụng hàm shell nhỏ này .

epy() { 
    cmd="import $1 as a ; print a.__file__.endswith('.pyc') and a.__file__[:-1] or a.__file__" 
    file=$(/usr/bin/env python -c $cmd) 
    echo $file 
    emacsclient --no-wait $file 
} 
0

Tôi đoán tôi sẽ bị giảm bớt nhưng tôi không thấy gì sai với tài liệu Sphinx và tôi tìm thấy cách này tốt hơn cách thay thế java.

+0

Tôi đồng ý. Nhân sư là một công cụ tốt và nó tạo ra tài liệu tốt. Ít nhất cho Python :) –

Các vấn đề liên quan