nb autodoc

nb-eutodoc

Inglés chino simplificado

Introducción

NB-AUTODOC es una herramienta que genera automáticamente documentos API a partir de anotaciones y documentos de tipo de código fuente de Python.

Esta herramienta encuentra todos los módulos del paquete y los importa, analiza el árbol de sintaxis abstracto, el tipo de tiempo de ejecución de cada módulo, vincula objetos internos, firmas de funciones analizadas y árboles de sintaxis de documentos, y finalmente genera un documento API completo, confiable y basado en enlaces.

Características principales

• Sistema de análisis de tipo basado en AST

• Pantallas de género modernos, como X | Y , list[str] , (*args) -> Any

• soporte de stub (.pyi)

• Soporte type_checking

• Reexportar el soporte, importar referencias de AST

• Soporte de función de sobrecarga de sobrecarga

uso

Instalar desde PIP:

 pip install nb-autodoc

Ejecute NB-Autodoc:

 nb-autodoc {package_name}

Otras opciones de línea de comando:

 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.

Consejo: use --undoc en lugar de --skip , que omitirá la importación y el análisis de los módulos.