ข้อมูลเกี่ยวกับฟังก์ชันหรือเอกสารประกอบถูกใส่ไว้ใน docstrings ในฟังก์ชัน ต่อไปนี้เป็นแนวทางปฏิบัติขณะเขียนเอกสารประกอบ
บรรทัดแรกควรเป็นบทสรุปสั้นๆ กระชับเกี่ยวกับจุดประสงค์ของวัตถุ เพื่อความกระชับ ไม่ควรระบุชื่อหรือประเภทของวัตถุอย่างชัดเจน บรรทัดนี้ควรขึ้นต้นด้วยอักษรตัวใหญ่และลงท้ายด้วยจุด
หากมีบรรทัดเพิ่มเติมในสตริงเอกสารประกอบ บรรทัดที่สองควรเว้นว่างไว้ โดยแยกข้อมูลสรุปออกจากคำอธิบายที่เหลือด้วยสายตา
สฟิงซ์
Sphinx เป็นเครื่องมือสร้างเอกสาร Python ที่ได้รับความนิยมมากที่สุด โดยจะแปลงภาษามาร์กอัป reStructuredText เป็นรูปแบบเอาต์พุตต่างๆ รวมถึง HTML, LaTeX (สำหรับเวอร์ชัน PDF ที่พิมพ์ได้) หน้าคู่มือ และข้อความธรรมดา
เมื่อเรียกใช้ สฟิงซ์จะนำเข้าโค้ดของคุณ และใช้คุณลักษณะวิปัสสนาของ Python ซึ่งจะแยกฟังก์ชัน วิธีการ และลายเซ็นของคลาสทั้งหมด นอกจากนี้ยังจะแยกเอกสารประกอบและรวบรวมทั้งหมดลงในเอกสารที่มีโครงสร้างที่ดีและอ่านง่ายสำหรับโครงการของคุณ
