Sphinx API 文档生成器
项目描述
注意: 这是对原始 sphinx-autoapi 的分支，目的是使其与 MyST-Parser 兼容。希望这些更改最终会被合并到上游。目标是
添加一组模板，用于与 MyST-Parser 一起使用
使其能够根据文件正则表达式编写具有特定扩展名的文件；我们希望用户能够逐步迁移现有代码库到 MyST-Parser，因此能够指定某些文件将非常有帮助。
Sphinx AutoAPI 为多种编程语言提供“autodoc”风格的文档，而无需加载、运行或导入要文档化的项目。
与传统的 Sphinx autodoc 相比，Sphinx autodoc 仅适用于 Python 并使用代码导入，AutoAPI 通过解析源代码来查找和生成文档。
语言支持
语言 |
状态 |
解析器 |
|---|---|---|
Python |
稳定 |
自定义使用 astroid |
Go |
零级 |
|
JavaScript |
零级 |
|
.NET |
零级 |
入门
以下步骤将指导您如何将AutoAPI添加到现有的Sphinx项目中。有关如何设置Sphinx项目的说明，请参阅Sphinx的入门指南。
安装
AutoAPI可以通过pip进行安装
pip install sphinx-autoapi接下来，在您的Sphinx项目的< cite>conf.py中添加和配置AutoAPI。其他语言可能需要进一步配置
extensions.append('autoapi.extension')
autoapi_type = 'python'
autoapi_dirs = ['path/to/source/files', 'src']其中< cite>autoapi_type可以是支持的任何语言之一
语言 |
autoapi_type |
|---|---|
Python |
'python' |
Go |
'go' |
JavaScript |
'javascript' |
.NET |
'dotnet' |
当文档构建时，AutoAPI现在将生成API文档到< cite>autoapi/目录，并在您的顶级目录中添加一个条目！
要进一步配置AutoAPI行为，请参阅配置文档。
贡献
运行测试
测试是通过tox执行的。
tox代码风格
代码使用black进行格式化。
您可以使用black的检查模式检查您的格式
tox -e formatting您还可以让black为您格式化更改
black autoapi/ tests/您甚至可以在提交时让black自动格式化更改，使用pre-commit
pip install pre-commit
pre-commit install版本控制
许可证
此项目采用MIT许可证。有关详细信息，请参阅LICENSE.rst文件。
项目详情
下载文件
下载适合您平台的文件。如果您不确定选择哪个，请了解有关安装包的更多信息。
