Thông tin về một hàm hoặc tài liệu được đưa vào docstrings trong một hàm. Sau đây là các nguyên tắc cần tuân thủ khi viết docstrings.
Dòng đầu tiên phải luôn là một bản tóm tắt ngắn gọn, súc tích về mục đích của đối tượng. Để ngắn gọn, nó không nên trình bày rõ ràng tên hoặc loại của đối tượng. Dòng này phải bắt đầu bằng một chữ cái in hoa và kết thúc bằng dấu chấm.
Nếu có nhiều dòng hơn trong chuỗi tài liệu, dòng thứ hai phải để trống, ngăn cách trực quan phần tóm tắt với phần còn lại của mô tả
Sphinx
Sphinx là công cụ tài liệu Python phổ biến nhất. Nó chuyển đổi ngôn ngữ đánh dấu reStructuredText thành một loạt các định dạng đầu ra bao gồm HTML, LaTeX (cho các phiên bản PDF có thể in được), các trang thủ công và văn bản thuần túy.
Khi chạy, Sphinx sẽ nhập mã của bạn và sử dụng các tính năng xem xét nội quan của Python, nó sẽ trích xuất tất cả các chữ ký hàm, phương thức và lớp. Nó cũng sẽ trích xuất các docstrings đi kèm và biên dịch tất cả thành tài liệu có cấu trúc tốt và dễ đọc cho dự án của bạn.