2012-08-20 27 views
5

Tôi đã tự hỏi liệu có thể sử dụng POD (tài liệu cũ cũ) với Python không? Và tôi nên làm như thế nào?Có thể sử dụng POD (tài liệu cũ cũ) với Python không?

+2

Tại sao bạn cần điều đó. Python có định dạng docstring rất riêng của nó được giải thích bởi 'pydoc'. Nếu bạn sử dụng POD, người dùng của mô-đun của bạn sẽ cần một công cụ để đọc nó. Bạn có chắc đây là những gì bạn muốn? Nếu bạn chỉ muốn tài liệu mã của bạn, sử dụng docstring của python. – javex

Trả lời

1

Dường như không có cách nào được hỗ trợ trực tiếp để sử dụng nội tuyến POD trong tệp Python. Tuy nhiên, các mô-đun Python (bao gồm thư viện chuẩn Python) được ghi lại bằng cách sử dụng reStructuredText. Điều này thường được thực hiện bằng cách sử dụng Sphinx, trong đó tạo tài liệu từ docstrings định dạng reStructuredText. Nhân sư và rst được thiết kế đặc biệt để điền vào một niche tương tự như POD.

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