nb autodoc

NB-Autodoc

Anglais chinois simplifié

Introduction

NB-Autodoc est un outil qui génère automatiquement des documents d'API à partir des annotations de type de code source Python et docstring.

Cet outil trouve tous les modules du package et les importe, analyse l'arborescence de syntaxe abstraite, le type d'exécution de chaque module, relie des objets internes, des signatures de fonction d'analyses et des arbres de syntaxe docstring, et génère enfin un document API complet, fiable et basé sur des liens.

Caractéristiques principales

• Système d'analyse de type AST basé sur AST

• Affichages de genre modernes, tels que X | Y , list[str] , (*args) -> Any

• Support Stub (.pyi)

• Type_checking Support

• Réexporter l'assistance, les références d'importation d'AST

• Prise en charge de la fonction de surcharge de surcharge

usage

Installer à partir de PIP:

 pip install nb-autodoc

Exécutez NB-Autodoc:

 nb-autodoc {package_name}

Autres options de ligne de commande:

 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.

Astuce: utilisez --undoc au lieu de --skip , qui sautera l'importation et l'analyse des modules.