用途:按既定工具与框架生成专业技术文档,包括 API 文档、用户指南、技术规范与知识库,并可在 CI/CD 中自动更新。
主要能力:Python 侧支持 Sphinx(autodoc、napoleon、typehints、myst_parser)与 MkDocs Material(mkdocstrings);TypeScript/JavaScript 侧支持 TypeDoc、JSDoc、TSDoc;API 文档支持 FastAPI 自动 OpenAPI(/docs、/redoc)与 Express + swagger-jsdoc/swagger-ui-express;静态站点支持 Nextra、Docusaurus、VitePress;通用格式含 Markdown、MDX、reStructuredText。还涉及从 SPEC 文件生成文档、GitHub Actions 文档流水线、链接检查(linkchecker、markdown-link-check)、拼写检查(pyspelling)与文档覆盖率(interrogate),以及 Nextra/Docusaurus 的多语言方案。
使用方式:按工具安装依赖并初始化项目,例如 pip install sphinx sphinx-autodoc-typehints sphinx-rtd-theme myst-parser 后运行 sphinx-quickstart docs;MkDocs 用 pip install mkdocs mkdocs-material mkdocstrings mkdocstrings-python,本地预览 mkdocs serve、构建 mkdocs build、部署 mkdocs gh-deploy;TypeDoc 用 npm install typedoc --save-dev 并配置 typedoc.json;JSDoc 用 npm install jsdoc --save-dev;Docusaurus 用 npx create-docusaurus@latest my-docs classic;VitePress 用 npm init vitepress。Sphinx 生成 API 文档可运行 sphinx-apidoc 后 make html。
适用场景:从代码注解生成 API 文档、搭建带搜索与导航的文档站点、编写用户指南与技术规范、在 CI/CD 中自动更新文档、转换文档格式。
限制:资料未提供具体收费、价格、平台支持范围与效果数据;部分能力依赖对应工具与插件版本,需按各工具官方文档配置。