sphinx扩展,用于提取和插入doxygen文档。
antidox的Python项目详细描述
摘要
antidox是一个Sphinx扩展,可以读取Doxygenxml“数据库”和 在sphinx文档中插入实体文档,类似于Breathe。
它的目的是fast和simple,尽管很容易定制。
文档生成(即doxy xml和structuredtext之间的转换)是 由XML样式表(由lxml供电)驱动,同时索引和选择 可记录的实体由sql数据库(sqlite3)完成。
这里有一个example project显示此扩展名 行动。
注:β
虽然可以使用,但这个扩展仍在开发中。向后的 所有具有相同主/次版本的版本都将保持兼容性。
但是,请注意,在更新此扩展之后,可能需要清除 创建文档以查看结果。
目标
- 在sphinx项目中重用用doxygen生成的api文档。
- 提供100%自动api文档(什么doxygen 生成)和半手动文档(autodoc样式)。
- 在允许 定制。
- 高效处理大型项目:现在使用的主要工具(呼吸) 处理大型XML文件时出现资源使用问题。