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
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
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

This version

1.0.0a5 pre-release

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.0a5.tar.gz (61.5 kB view details)

Uploaded Source

Built Distribution

nb_autodoc-1.0.0a5-py3-none-any.whl (52.0 kB view details)

Uploaded Python 3

File details

Details for the file nb-autodoc-1.0.0a5.tar.gz.

File metadata

  • Download URL: nb-autodoc-1.0.0a5.tar.gz
  • Upload date:
  • Size: 61.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: pdm/2.4.1 CPython/3.9.2

File hashes

Hashes for nb-autodoc-1.0.0a5.tar.gz
Algorithm Hash digest
SHA256 9341a2a231f9c1e97a040ee8701ff2e800ba742a1f1e548f7c92fbaa5d618e8b
MD5 425ef34d2ab6e5cb4a559aad8ed7a9df
BLAKE2b-256 d4303e2c61be3a9a7fc847decadf04143d2b4d7acf2fb227dd93e37c1b350dd8

See more details on using hashes here.

File details

Details for the file nb_autodoc-1.0.0a5-py3-none-any.whl.

File metadata

File hashes

Hashes for nb_autodoc-1.0.0a5-py3-none-any.whl
Algorithm Hash digest
SHA256 2158758d1d1cc959082f201719f0d343659306ef776546cd60f5b932b0f03488
MD5 79debafdbe24ce765620d427a1883f90
BLAKE2b-256 42252f890f58d29112e423db2eda45442b560c590e45157bbc4f77e04ebde460

See more details on using hashes here.

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