文件发生器
wurfapi的Python项目详细描述
简介
我们希望有一个可配置且易于使用的sphinx api文档 我们的C++项目的生成器。为了达到这个目的,我们依靠别人 灵感:
- 呼吸(https://github.com/michaeljones/breathe" rel="nofollow">https://github.com/michaeljones/breathe):极好的扩展 以及许多人的默认选择。
- gasp( https://github.com/troelsfr/gasp ):gasp通过允许 控制输出的模板。不幸的是差距的扩大 好像已经停了。
那么什么是wurfapi
- 从本质上讲,我们是从喘息的地方开始的。我们有 借鉴了模板的思想,使其高度可配置。
- 我们通过自动运行doxygen来生成 初始API文档。
- 我们将doxygen xml解析为一个易于使用的python字典。哪能 在模板中使用。
- 我们为其他后端准备了扩展(替换doxygen)。 一旦准备好,就可以使用https://github.com/foonathan/standardese" rel="nofollow">https://github.com/foonathan/standardese。