> For the complete documentation index, see [llms.txt](https://huataihuang.gitbook.io/cloud-atlas-draft/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://huataihuang.gitbook.io/cloud-atlas-draft/develop/doc/sphinx.md).

# Sphinx

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

Sphinx使用[reStructuredText](http://docutils.sourceforge.net/rst.html)语法，相对MarkDown语法要复杂很多，但也功能更为强大。

[Riv: Take Notes in rst](https://github.com/gu-fan/riv.vim) 是一个vim插件，可以实时显示vim所编辑的rst文件效果，可以结合使用。

[build-me-the-docs-please](https://build-me-the-docs-please.readthedocs.io/en/latest/index.html) 是我偶尔搜索 Sphinx + PlantUML 看到的一个知识管理、issue管理的经验分享文档，非常详尽，可以参考。