vscode 怎么编辑sphinx_技术文档撰写利器:VsCode +Read The Docs 环境搭建

3687d97008d5f118185daf4241a15e6f.png

在浏览github时会发现好多开源项目都有自己的技术文档,它的格式和风格都很类似,在网上查了一下才知道原来他们都是使用了Read The Docs 来进行编写的。它的有点就是风格统一支持markdown,编写简单,自动化生成文档,对于技术人员来说很方便。

搭建环境:

说明:因为我是做嵌入式开发的linux环境和Windows都在用,因此在Windows上安装了wsl(Windows Subsystem for Linux),wsl对于一般的开发已经足够了。平时我一般使用vscode阅读和编辑代码。

7c77004ed0bb2630c5fbf67211505df2.png

安装

  • 打开VsCode ,选择新建终端(crtl+shift+`),默认终端选择wsl 以下操作都是在vscode的终端中完成
  • 安装sphinx
$ pip install sphinx sphinx-autobuild sphinx_rtd_theme
  • 0
    点赞
  • 2
    收藏
    觉得还不错? 一键收藏
  • 0
    评论

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值