Powerful API Documentation Generator.

Navigation

Verified details

These details have been verified by PyPI
Maintainers
Avatar for iyume from gravatar.com iyume

Unverified details

These details have not been verified by PyPI
Project links
GitHub Statistics

View statistics for this project via Libraries.io, or by using our public dataset on Google BigQuery

Meta

License: MIT

Author: iyume

Tags nonebot, autodoc, ast, inspect, apidoc, documentation-tool, markdown

Requires: Python >=3.8

Project description

nb-autodoc

nb-autodoc

python version pypi version

简体中文 · English

简介

nb-autodoc 是一个从 Python 源码的 类型注解 和 Docstring 自动生成 API 文档的工具。

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

主要特性

  • 基于 AST 的类型分析系统

  • stub (.pyi) 支持

  • TYPE_CHECKING 支持

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

  • Overload 重载函数支持

Project details

Verified details

These details have been verified by PyPI
Maintainers
Avatar for iyume from gravatar.com iyume

Unverified details

These details have not been verified by PyPI
Project links
GitHub Statistics

View statistics for this project via Libraries.io, or by using our public dataset on Google BigQuery

Meta

License: MIT

Author: iyume

Tags nonebot, autodoc, ast, inspect, apidoc, documentation-tool, markdown

Requires: Python >=3.8


Release history Release notifications | RSS feed

1.0.0a7 pre-release

1.0.0a6 pre-release

1.0.0a5 pre-release

This version

1.0.0a4 pre-release

1.0.0a3 pre-release

1.0.0a2 pre-release

1.0.0a1 pre-release

0.1.1 yanked

Reason this release was yanked:

only test for fixing garbled from "pdm publish"

0.1.0 yanked

Reason this release was yanked:

export pre-release

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

nb-autodoc-1.0.0a4.tar.gz (61.1 kB view hashes)

Uploaded Source

Built Distribution

nb_autodoc-1.0.0a4-py3-none-any.whl (51.7 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page