ReadtheDocs 项目用 markdown 格式来书写文档

场景

公司的一个项目

项目地址：http://dev.canonchain.com/

需要做一些文档，用来帮助开发者；

需要用到多版本 / 多语言的文档管理

所以使用 ReadtheDocs 来实现这个需求；

但是使用的时候，因为默认是用 rst 格式的，不支持 markdown，而我们团队对 markdown 更有好感；

所以做了 markdown 的兼容

解决方案

默认不支持 markdown 写法，需要安装recommonmark插件

pip install recommonmark

还需要修改 conf.py 文件

#编辑配置文件source/conf.py在最后一行复制下方配置
from recommonmark.parser import CommonMarkParser
source_parsers = {
    '.md': CommonMarkParser,
}
source_suffix = ['.rst', '.md']

具体的位置如下

然后就可以正常使用了，剩下就是编译部署的事情了；