nb autodoc

NB-Autodoc

Bahasa Inggris Cina yang disederhanakan

Perkenalan

NB-Autodoc adalah alat yang secara otomatis menghasilkan dokumen API dari anotasi jenis kode sumber Python dan docString.

Alat ini menemukan semua modul dari paket dan mengimpornya, mem-parsing pohon sintaks abstrak, jenis runtime dari setiap modul, menghubungkan objek internal, tanda tangan fungsi parse dan pohon sintaks DocString, dan akhirnya menghasilkan dokumen API yang lengkap, andal, dan berbasis tautan.

Fitur utama

• Sistem analisis tipe berbasis AST

• Tampilan genre modern, seperti X | Y , list[str] , (*args) -> Any

• Dukungan Stub (.pyi)

• Type_checking dukungan

• Ekspor kembali dukungan, impor referensi dari AST

• Dukungan fungsi kelebihan beban kelebihan beban

penggunaan

Instal dari Pip:

 pip install nb-autodoc

Jalankan NB-Autodoc:

 nb-autodoc {package_name}

Opsi baris perintah lainnya:

 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.

Kiat: Gunakan --undoc bukannya --skip , yang akan melewatkan impor dan analisis modul.