Appearance

将 Vscode 配置为 sphinx-doc 的趁手编辑器 ​

rst 语言支持 ​

安装插件 reStructuredText

1) QA: doc8 warns “D001 Line Too Long” ​

doc8 检测行的长度, 并且推荐最大的长度为 79 字符.

有几种方法可以改变这个设定

--max-line-length int

你可以指定一个整数值，而不是79, 这样来关闭这个提示

--ignore D001

取消对于 D001 错误的提示, 这个参数设定可以传递给 doc8 的命令行,可以如下配置

json
{
    "restructuredtext.linter.extraArgs": [
        "--ignore D001"
    ]
}

2) 支持的语法脚本 ​

如果出现 ...filename.md: WARNING: 未知的 Pygments 词法分析器 'jsx' , 我们可以安装 jsx 语法的提示器

$ pip install jsx-lexer

RST 预览 ​

rst 预览的流程是, 配置解析器, 编译生成 html, 渲染 html 展示

安装插件 Preview

配置 Python 的解析器 查看 - 命令面板 , 输入 python:

选择合适的解析器

这里根据自己 python 版本来选择使用哪个来作为解析器, 然后点击右上角预览便可以进行演示

图片粘贴 ​

安装插件 Paste Image

安装之后可以使用 alt + cmd + v 来将图片直接粘贴到编辑器中,直接粘贴的图片默认位置和命名并不符合我们的要求, 所以需要重新进行配置

配置日期的参考文档: Moment 格式

json
{
    "settings": {
        "pasteImage.basePath": "${projectRoot}",
        "pasteImage.defaultName": "Y/MMDD/HHmmss",
        "pasteImage.prefix": ".. image:: /",
        "pasteImage.path": "${projectRoot}/_static/images/",
        "pasteImage.encodePath": "none"
    }
}

这样我们粘贴图片的之后就可以直接将文件粘贴到 /_static/images/2020/0131/191053.png 类似目录下

说明

创建时间: 2023-01-15 00:28:00 , 最后编辑于 2023-12-20 10:35:00