Sphinx

Sphinx Doc最初是作为Python代码文档自动生成工具,现在也开始支持C/C++,以及计划支持更多语言程序文档的创建。由于文档撰写格式优雅,逐渐作为技术文档的撰写平台使用。

Sphinx使用reStructuredText语法,相对MarkDown语法要复杂很多,但也功能更为强大。

Riv: Take Notes in rst 是一个vim插件,可以实时显示vim所编辑的rst文件效果,可以结合使用。

build-me-the-docs-please 是我偶尔搜索 Sphinx + PlantUML 看到的一个知识管理、issue管理的经验分享文档,非常详尽,可以参考。

Last updated