Metadata-Version: 2.1
Name: nb-autodoc
Version: 1.0.0a2
Summary: Powerful API Documentation Generator.
License: MIT
Keywords: nonebot,autodoc,ast,inspect,apidoc,documentation-tool,markdown
Author-email: iyume <iyumelive@gmail.com>
Requires-Python: >=3.8
Project-URL: homepage, https://github.com/nonebot/nb-autodoc
Project-URL: repository, https://github.com/nonebot/nb-autodoc
Description-Content-Type: text/markdown

<div align="center">

<img src="logo/logo.png" width=200, height=200 alt="nb-autodoc"></img>

# nb-autodoc

![python version](https://img.shields.io/badge/python-3.8+-%233eca5d)
![pypi version](https://img.shields.io/pypi/v/nb-autodoc)

[简体中文](README.md)
·
[English](README_en.md)

</div>

## 简介

nb-autodoc 是一个从 Python 源码的 [类型注解](https://docs.python.org/3/library/typing.html) 和 [Docstring](https://peps.python.org/pep-0257/) 自动生成 API 文档的工具。

本工具从包里查找所有的模块并导入，解析各模块的抽象语法树、运行时类型，链接内部对象，解析函数签名和 docstring 语法树，最终生成完整、可靠、带有链接的 API 文档。

## 主要特性

- 基于 AST 的类型分析系统

- stub (.pyi) 支持

- TYPE_CHECKING 支持

- Re-export 支持，从 AST 解析导入引用

- Overload 重载函数支持

