Esbonio

Esbonio VSCode扩展将esbonio语言服务器集成到Visual Studio Code中，为Sphinx文档项目提供类似IDE的功能，适用于reStructuredText和Markdown文件。

主要功能：

实时预览

扩展支持实时显示HTML预览，文档更新时预览内容会自动刷新，并且支持源文件与预览间的同步滚动。

自动补全

语言服务器在多种上下文中提供补全建议，提升编辑效率。

跳转定义

支持通过:ref:和:doc:角色链接跳转到定义。

跳转实现

对角色和指令支持跳转到实现。

诊断功能

构建过程中的错误会以诊断信息的形式在VSCode中显示。

悬停信息

为某些角色和指令提供文档悬停信息。

文档与工作区符号

文档中的章节标题和指令被识别为符号，并在“概要”视图中显示。您还可以使用Ctrl T快捷键在工作区内搜索符号。

设置：

esbonio语言服务器与此扩展捆绑，无需单独安装。但服务器需要访问您用于构建文档的Python环境。

1. 在VSCode中打开包含文档项目的文件夹（仅打开单个文件且没有活动工作区目前不受支持，会导致错误）。

2. 使用Python扩展中的“Python: 选择解释器”命令，选择用于构建文档的环境（可能需要运行“Esbonio: 重启语言服务器”命令使其生效）。

   或者，您可以通过设置esbonio.sphinx.pythonCommand选项来覆盖使用的Python解释器。

3. 打开Sphinx项目中的reStructuredText或markdown文件。

4. Sphinx构建输出将在VSCode面板中的Esbonio输出视图中可用。

依赖扩展：

Esbonio依赖以下扩展：

• 默认情况下，Esbonio依赖官方Python扩展来配置构建文档的环境。
• MyST语法高亮扩展为MyST风格的markdown提供语法高亮规则。

补充扩展：

以下扩展虽然不是使用Esbonio的必需品，但您可能会发现它们有用：

• reStructuredText扩展整合了许多其他有用的工具，如传统的lint工具如doc8和rstcheck。它还为一般reStructuredText文件提供了额外的编辑器功能。
• 虽然VSCode自v1.66起已包含reStructuredText语法高亮扩展的供应版本，但从市场安装扩展将为您提供最新版本的语法定义。