关于本项目

本项目的github地址：https://github.com/Embdefire/ebf_contribute_guide

本项目的gitee 地址：https://gitee.com/wildfireteam/ebf_contribute_guide

点击右侧链接可在线阅读本项目文档：《 [野火]sphinx文档规范与模版 》

本文档是关于如何使用sphinx编写文档的说明。 也可以把本文档作为模版创建其它sphinx的文档。

为什么使用sphinx编写文档

使用shpinx编写文档有如下优点：

• 使用sphinx编写的文档可以方便地制作html、pdf等格式，非常方便浏览和转换。
• sphinx支持rst和markdown语法，方便共享及开源编辑，使用git也方便跟踪。
• 由于rst语法比markdown语法更强大和方便，我们主要采用rst语法编写文档， linux内核源码文档也是使用rst格式编写的。 我们的文档也支持markdown，主要是为了方便不熟悉rst的用户参与进来。