{"id":20390245,"url":"https://github.com/nonebot/nb-autodoc","last_synced_at":"2025-04-12T11:21:03.146Z","repository":{"id":51683203,"uuid":"431026824","full_name":"nonebot/nb-autodoc","owner":"nonebot","description":"Python API documentation tool supporting the modern PEPs and typing features.","archived":false,"fork":false,"pushed_at":"2023-06-23T15:06:02.000Z","size":643,"stargazers_count":10,"open_issues_count":0,"forks_count":2,"subscribers_count":3,"default_branch":"main","last_synced_at":"2024-10-29T23:38:43.792Z","etag":null,"topics":["apidoc","autodoc","documentation-tool","markdown","nonebot","python","runtime-analysis","static-analysis"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/nonebot.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null},"funding":{"open_collective":"nonebot","custom":["https://afdian.net/@nonebot"]}},"created_at":"2021-11-23T08:54:01.000Z","updated_at":"2024-08-19T02:28:56.000Z","dependencies_parsed_at":"2023-02-17T05:00:33.437Z","dependency_job_id":null,"html_url":"https://github.com/nonebot/nb-autodoc","commit_stats":{"total_commits":333,"total_committers":2,"mean_commits":166.5,"dds":"0.0030030030030030463","last_synced_commit":"65247fc1194597fb10d5d767bf7f1acde5074403"},"previous_names":[],"tags_count":5,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nonebot%2Fnb-autodoc","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nonebot%2Fnb-autodoc/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nonebot%2Fnb-autodoc/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nonebot%2Fnb-autodoc/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/nonebot","download_url":"https://codeload.github.com/nonebot/nb-autodoc/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248558126,"owners_count":21124223,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["apidoc","autodoc","documentation-tool","markdown","nonebot","python","runtime-analysis","static-analysis"],"created_at":"2024-11-15T03:23:48.847Z","updated_at":"2025-04-12T11:21:03.124Z","avatar_url":"https://github.com/nonebot.png","language":"Python","funding_links":["https://opencollective.com/nonebot","https://afdian.net/@nonebot"],"categories":[],"sub_categories":[],"readme":"\u003cdiv align=\"center\"\u003e\n\n\u003cimg src=\"https://raw.githubusercontent.com/nonebot/nb-autodoc/main/logo/logo.png\" width=200, height=200 alt=\"nb-autodoc\"\u003e\u003c/img\u003e\n\n# nb-autodoc\n\n![python version](https://img.shields.io/badge/python-3.8+-%233eca5d)\n![pypi version](https://img.shields.io/pypi/v/nb-autodoc)\n\n[简体中文](https://github.com/nonebot/nb-autodoc/blob/main/README.md)\n·\n[English](https://github.com/nonebot/nb-autodoc/blob/main/README_en.md)\n\n\u003c/div\u003e\n\n## 简介\n\nnb-autodoc 是一个从 Python 源码的 [类型注解](https://docs.python.org/3/library/typing.html) 和 [Docstring](https://peps.python.org/pep-0257/) 自动生成 API 文档的工具。\n\n本工具从包里查找所有的模块并导入，解析各模块的抽象语法树、运行时类型，链接内部对象，解析函数签名和 docstring 语法树，最终生成完整、可靠、带有链接的 API 文档。\n\n## 主要特性\n\n- 基于 AST 的类型分析系统\n\n- 现代的类型展示，如 `X | Y`、`list[str]`、`(*args) -\u003e Any`\n\n- stub (.pyi) 支持\n\n- TYPE_CHECKING 支持\n\n- Re-export 支持，从 AST 解析导入引用\n\n- Overload 重载函数支持\n\n## 用法\n\n从 pip 安装:\n\n```\npip install nb-autodoc\n```\n\n运行 nb-autodoc:\n\n```\nnb-autodoc {package_name}\n```\n\n其他命令行选项:\n\n```\nUsage: nb-autodoc [OPTIONS] MODULE\n\nOptions:\n  -o, --output-dir DIRECTORY      [default: build]\n  -s, --skip TEXT                 skip import modules\n  -u, --undoc TEXT                undocument modules\n  --markdown-linkmode [heading_id|vuepress]\n                                  [default: heading_id]\n  --help                          Show this message and exit.\n```\n\n**提示:** 使用 `--undoc` 而不是 `--skip`，后者会跳过模块的导入和分析。\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnonebot%2Fnb-autodoc","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fnonebot%2Fnb-autodoc","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnonebot%2Fnb-autodoc/lists"}