nb autodoc

NB-Autodoc

Inglês chinês simplificado

Introdução

O NB-Autodoc é uma ferramenta que gera automaticamente os documentos da API das anotações e Docstring do tipo de código-fonte do Python.

Essa ferramenta encontra todos os módulos do pacote e os importa, analisa a árvore de sintaxe abstrata, o tipo de tempo de execução de cada módulo, vincula objetos internos, analisa assinaturas de função e árvores de sintaxe de docstring e, finalmente, gera um documento de API completo e baseado em links.

Principais características

• Sistema de análise de tipo AST

• Exibições de gênero modernas, como X | Y , list[str] , (*args) -> Any

• suporte (.pyi)

• Suporte Type_Checking

• Reexportar suporte, importar referências da AST

• Suporte de sobrecarga de suporte à função

uso

Instale de Pip:

 pip install nb-autodoc

Execute NB-Autodoc:

 nb-autodoc {package_name}

Outras opções de linha 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.

Dica: use --undoc em vez de --skip , que pulará a importação e análise de módulos.