Sphinx AutoAPI

Sphinx AutoAPI 是用于生成完整 API 文档的 Sphinx 扩展,无需加载、运行或导入正在记录的项目。

与传统的 Sphinx autodoc 不同,AutoAPI 通过解析源代码来查找和生成文档,而无需手动编写作者指南或使用代码导入。

入门指南

新用户?查看教程。它们是初学者的动手介绍。

用户指南

用户指南是关键任务和常见问题的解决方案。

参考指南

参考指南包含 AutoAPI 中包含的配置选项、指令和模板的详细描述。

贡献者指南

想为代码库做出贡献?贡献者指南将指导您改进 AutoAPI。