repoze.sphinx.autointerface กำหนดส่วนขยายสำหรับระบบเอกสารสฟิงซ์ & nbsp;. ขยายช่วยให้การสร้างเอกสาร API โดยวิปัสสนากรณี zope.interface ในรหัส
การติดตั้ง:
การติดตั้งผ่านทาง easy_install:
bin / easy_install repoze.sphinx.autointerface
หรือวิธีการอื่นใดที่ได้รับแพคเกจใน PYTHONPATH ของคุณ
ลงทะเบียนขยาย
เพิ่ม repoze.sphinx.autointerface ในรายการส่วนขยายใน conf.py ของสฟิงซ์เอกสารสำหรับผลิตภัณฑ์ของคุณ E.g .:
นามสกุล = ['sphinx.ext.autodoc',
& nbsp; 'sphinx.ext.doctest',
& nbsp; 'repoze.sphinx.autointerface',
& nbsp;]
การใช้ขยาย
ที่จุดที่เหมาะสมในเอกสารของคุณโทรออกอินเตอร์เฟซ autodocs ผ่าน:
.. autointerface :: yourpackage.interfaces.IFoo
ออกจากคำสั่งรวมถึง
& nbsp; * ชื่ออินเตอร์เฟซที่มีคุณสมบัติทั้งหมด
& nbsp; * การเชื่อมต่อฐานใด ๆ
& nbsp; * doctstring จากอินเตอร์เฟซกลายเป็น reSTX
& nbsp; * สมาชิกของอินเตอร์เฟซ (วิธีการและคุณลักษณะ)
& nbsp; o สําหรับแต่ละแอตทริบิวต์การส่งออกรวมถึงชื่อแอตทริบิวต์และคำอธิบาย
& nbsp; o สําหรับแต่ละวิธีการส่งออกรวมถึงชื่อวิธีลายเซ็นของตนและ docstring มัน (การแสดงผลยังเป็น reSTX)
มีอะไรใหม่ ในข่าวประชาสัมพันธ์ฉบับนี้.
- PyPy ความเข้ากันได้.
- หลาม 3.2+ ความเข้ากันได้ ขอขอบคุณสำหรับแพทช์ Arfrever.
- รวมเอกสารภายใต้อินเตอร์เฟซที่สั่ง automodule ขอบคุณที่ Krys อเรนซ์สำหรับแพทช์.
มีอะไรใหม่ ในรุ่น 0.6.2:
- TypeError แก้ไข: วัตถุ NoneType 'ไม่ iterable ข้อผิดพลาดเมื่อมีการสร้างการแสดงผลของอินเตอร์เฟซภายใต้หลาม 2.7.
มีอะไรใหม่ ในรุ่น 0.6.1:
- แก้ไข ': สมาชิกสั่งซื้อ: bysource' การจัดการ .
มีอะไรใหม่ ในรุ่น 0.6:
- จัดการอย่างถูกต้อง ': สมาชิก:' ค่าอย่างชัดเจนที่ตั้งอยู่ใน สั่ง.
มีอะไรใหม่ ในรุ่น 0.5:
- เพิ่มการสนับสนุนสำหรับ ': สมาชิกสั่งซื้อ:' ธง ซึ่งอาจใช้เวลาหนึ่งในสามของค่าหุ้น & quot; ตัวอักษร & quot ;, & quot; GroupWise & quot ;, หรือ & quot; bysource & quot ;. โดยค่าเริ่มต้นสมาชิกจะมีการบันทึกไว้ใน & quot; กัญชา & quot; การสั่งซื้อสินค้า.
ต้องการ
- หลาม
- สฟิงซ์
ความคิดเห็นที่ไม่พบ