nb autodoc

nb-autodoc

Simplified Chinese English

Introduction

nb-autodoc is a tool that automatically generates API documents from Python source code type annotations and Docstring.

This tool finds all modules from the package and imports them, parses the abstract syntax tree, runtime type of each module, links internal objects, parses function signatures and docstring syntax trees, and finally generates a complete, reliable, and link-based API document.

Main features

• AST-based type analysis system

• Modern genre displays, such as X | Y , list[str] , (*args) -> Any

• stub (.pyi) support

• TYPE_CHECKING Support

• Re-export support, import references from AST

• Overload overload function support

usage

Install from pip:

 pip install nb-autodoc

Run nb-autodoc:

 nb-autodoc {package_name}

Other command line options:

 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.

Tip: Use --undoc instead of --skip , which will skip the import and analysis of modules.