Sphinx API文献发生器
sphinx-autoapi的Python项目详细描述
sphinx autoapi为多种编程语言提供“autodoc”风格的文档 无需加载、运行或导入正在记录的项目。
与传统的Sphinx autodoc相比， 只使用python并使用代码导入， autoapi通过解析源代码来查找和生成文档。
语言支持
| Language | Status | Parser |
|---|---|---|
| Python | Stable | Custom using astroid |
| Go | Alpha | godocjson |
| Javascript | Alpha | jsdoc |
| .NET | Alpha | docfx |
开始
下面的步骤将介绍如何将AutoAPI添加到现有的狮身人面像项目中。 有关如何设置狮身人面像项目的说明， 参见斯芬克斯的文档 Getting Started。
安装
AutoAPI可以通过PIP安装：
pip install sphinx-autoapi
接下来，在sphinx项目的conf.py中添加并配置autoapi。 其他语言可能需要 further configuration：
extensions.append('autoapi.extension')autoapi_type='python'autoapi_dirs=['path/to/source/files','src']
其中，autoapi类型可以是任何受支持的语言之一：
| Language | ^{tt1}$ |
|---|---|
| Python | ^{tt2}$ |
| Go | ^{tt3}$ |
| Javascript | ^{tt4}$ |
| .NET | ^{tt5}$ |
当文档生成时， autoapi现在将把api文档生成到autoapi/目录中，并在顶级目录中的文档中添加一个条目！
要进一步配置autoapi行为， 见Configuration documentation。
贡献
代码样式
代码使用black格式化。
您可以使用黑色的检查模式检查格式：
tox -e formatting
您也可以使用黑色为您设置更改格式：
black autoapi/ tests/
使用pre-commit：
pip install pre-commit pre-commit install
版本控制
我们使用SemVer进行版本控制。有关可用的版本，请参见tags on this repository。
许可证
这个项目是由麻省理工学院授权的。 有关详细信息，请参见LICENSE.rst文件。
欢迎加入QQ群-->： 979659372
