nb autodoc

nb-autodoc

ภาษาอังกฤษภาษาจีนง่ายๆ

การแนะนำ

NB-AUTODOC เป็นเครื่องมือที่สร้างเอกสาร API โดยอัตโนมัติจาก Python Source COLOSE Type Annotations และ DocString

เครื่องมือนี้ค้นหาโมดูลทั้งหมดจากแพ็คเกจและนำเข้าวิเคราะห์แผนผังนามธรรมแบบนามธรรมประเภทรันไทม์ของแต่ละโมดูลลิงก์วัตถุภายในการแยกฟังก์ชั่นลายเซ็นฟังก์ชั่นและเอกสารไวยากรณ์เอกสารและในที่สุดก็สร้างเอกสาร API ที่สมบูรณ์เชื่อถือได้และลิงก์

คุณสมบัติหลัก

• ระบบการวิเคราะห์ประเภท AST

• การแสดงประเภทที่ทันสมัยเช่น X | Y , list[str] , (*args) -> Any

• การสนับสนุนต้นขั้ว (.pyi)

• การสนับสนุน type_checking

• การสนับสนุนการส่งออกอีกครั้งนำเข้าอ้างอิงจาก AST

• ฟังก์ชั่นโอเวอร์โหลดโอเวอร์โหลด

การใช้งาน

ติดตั้งจาก PIP:

 pip install nb-autodoc

เรียกใช้ nb-autodoc:

 nb-autodoc {package_name}

ตัวเลือกบรรทัดคำสั่งอื่น ๆ :

 Usage: nb-autodoc [OPTIONS] MODULE

Options:
  -o, --output-dir DIRECTORY      [default: build]
  -s, --skip TEXT                 skip import modules
  -u, --undoc TEXT                undocument modules
  --markdown-linkmode [heading_id|vuepress]
                                  [default: heading_id]
  --help                          Show this message and exit.

เคล็ดลับ: ใช้ --undoc แทน --skip ซึ่งจะข้ามการนำเข้าและวิเคราะห์โมดูล