nb autodoc

NB-AUTODOC

Vereinfachtes chinesisches Englisch

Einführung

NB-AUTODOC ist ein Tool, das automatisch API-Dokumente aus Annotationen des Python-Quellcode-Typs und der DOCString generiert.

Dieses Tool findet alle Module aus dem Paket und importiert sie, analysiert den abstrakten Syntaxbaum, den Laufzeittyp jedes Moduls, verknüpft interne Objekte, Parse-Funktionssignaturen und Dokument-Syntaxbäume und erzeugt schließlich ein vollständiges, zuverlässiges und linkbasiertes API-Dokument.

Hauptmerkmale

• AST-basierter Typanalysesystem

• Moderne Genre -Displays wie X | Y , list[str] , (*args) -> Any

• Stub (.pyi) Unterstützung

• Type_Checking -Unterstützung

• Unterstützung durchsetzen, Referenzen von AST importieren, importieren

• Überlastungsfunktionsunterstützung überlasteten

Verwendung

Installieren Sie von PIP:

 pip install nb-autodoc

Führen Sie NB-Autodoc aus:

 nb-autodoc {package_name}

Andere Befehlszeilenoptionen:

 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.

Tipp: Verwenden Sie --undoc anstelle von --skip , das die Import und Analyse von Modulen überspringt.