Esbonio

The Esbonio extension integrates the esbonio language server into VSCode.

The esbonio language server aims to make it easier to work with Sphinx documentation projects by bringing IDE-like features to your documentation.

Features

Live Preview

The extension can show a live HTML preview of the documentation

Completions

The language server can provide completion suggestions in various contexts

Goto Defintion

Goto definition is currently implemented for objects linked to by :ref: and :doc: roles

Goto Implementation

Goto implementation is available for roles and directives

Diagnostics

Errors from a build are published to VSCode as diagnostics

Hover

Documentation is provided for certain roles and directives

Outline

Sections within a document are displayed in the "Outline" view

Alternatives

The reStructuredText extension as of v171.0.0 also integrates the esbonio language server into VSCode. It also integrates other tools such as the linters doc8 and rstcheck and provides additional editor functionality for working with reStructuredText in general.