Sphinx API 文档生成器
项目描述
Sphinx AutoAPI 是一个 Sphinx 扩展，可以在不加载、运行或导入正在编写的项目的情况下生成完整的 API 文档。
与传统的 Sphinx autodoc 相比，它需要手动编写并使用代码导入，AutoAPI 通过解析源代码来查找和生成文档。
更多信息，请参阅 完整文档。
开始使用
以下步骤将介绍如何将 AutoAPI 添加到现有的 Sphinx 项目中。有关如何设置 Sphinx 项目的说明，请参阅 Sphinx 文档。
安装
AutoAPI可以通过pip进行安装。
pip install sphinx-autoapi接下来，在Sphinx项目的conf.py文件中添加和配置AutoAPI。
extensions.append('autoapi.extension')
autoapi_dirs = ['path/to/source/files', 'src']当生成文档时，AutoAPI现在将API文档生成到autoapi/目录，并在顶级目录表中添加条目！
要进一步配置AutoAPI行为，请参阅配置文档。
贡献
运行测试
测试通过tox执行。
tox代码风格
代码使用black格式化。
您可以使用black的检查模式检查您的格式。
tox -e format您也可以让black为您格式化更改。
black autoapi/ tests/您甚至可以在提交时让black自动格式化更改，使用pre-commit。
pip install pre-commit
pre-commit install发布说明
发布说明通过towncrier管理。提交拉取请求时，您需要创建一个新闻片段来记录您的更改。
tox -e release_notes -- create --help版本管理
许可证
本项目受MIT许可证许可。有关详细信息，请参阅LICENSE.rst文件。
项目详情
关闭
sphinx_autoapi-3.3.2.tar.gz的哈希值
| 算法 | 哈希摘要 | |
|---|---|---|
| SHA256 | ebf8b44b2ebab5c28f0263ec6c2f8acdd156e9b2d539a58eca39d2f368445173 |
|
| MD5 | 87ae307f4607c8cc814291aad81c6293 |
|
| BLAKE2b-256 | e100aeca40dec5288678df6dbe69c9fcc3fd5d53d1f94a462f4e6bb821d389a8 |
关闭
sphinx_autoapi-3.3.2-py2.py3-none-any.whl 的哈希值
| 算法 | 哈希摘要 | |
|---|---|---|
| SHA256 | 08afa656f7fcd45fe7dd64bf9f44698ddb8ca7c2d5cd0614c7455912ed580324 |
|
| MD5 | a88e512bc949d63a2f4d18b9a9bb4315 |
|
| BLAKE2b-256 | 71f473094ddb805607c5661e1b80f528e5235710e52b37a890423ad2ba5a7cee |