在浏览github时会发现好多开源项目都有自己的技术文档,它的格式和风格都很类似,在网上查了一下才知道原来他们都是使用了Read The Docs 来进行编写的。它的有点就是风格统一支持markdown,编写简单,自动化生成文档,对于技术人员来说很方便。
搭建环境:
说明:因为我是做嵌入式开发的linux环境和Windows都在用,因此在Windows上安装了wsl(Windows Subsystem for Linux),wsl对于一般的开发已经足够了。平时我一般使用vscode阅读和编辑代码。
安装
- 打开VsCode ,选择新建终端(crtl+shift+`),默认终端选择wsl 以下操作都是在vscode的终端中完成
- 安装sphinx
$ pip install sphinx sphinx-autobuild sphinx_rtd_theme