本文共 914 字,大约阅读时间需要 3 分钟。
摘自:
CRUD 程序员
Sphinx 是一种文档工具,基于reStructuredText/rst格式编写文档,
有着众多的插件和良好的生态,可以生成高质量的出版级别的文档.
具体可以参考,
Sphinx在Python圈非常出名,几乎所有开源项目的文档都是sphinx编写
大部分托管在
但是一直没找到好的编写工具或者Sphinx编辑软件.
vim之类的插件容易实现,但是需要定制的很多,
有界面的sphinx-doc编写app质量都很差.
大多年久失修.或者功能缺失,比如基于pandoc的转换,需要脑补下才可以.
常用IDE, idea和pycharm里面的的插件也非常不好用.
找了很多地方
stackoverflow和github都找遍了,这里的基本上能找到的关于sphinx-doc reStructuredText 方式的编辑软件试过了,没有一个能打的 .
无意间在github的topic下找到一个vs插件,试了一下很好用.
推荐:
如果遇到python问题
用这个指定python解释器
必须为python3以上把.python2的中文编码坑的比较
这里列举了不少的文档
vs插件的特点是:
不足:
vs下载地址参见:
如果你想支持在vs中copy图片,生成路径
可以看下Paste Image 这个插件
rst相关语法的中文版本可以参见
最后再配合 vscode 的配置 .setting.json 配置 很方便将4个缩进切到三个缩进
{ "python.pythonPath": "./venv/bin/python3.7", "restructuredtext.confPath": "${workspaceFolder}", "editor.detectIndentation": false, "editor.insertSpaces": true, "editor.tabSize": 3,}
编辑于 2019-12-18
转载地址:http://zumni.baihongyu.com/