Skip to content

Latest commit

 

History

History
100 lines (61 loc) · 4.94 KB

README.md

File metadata and controls

100 lines (61 loc) · 4.94 KB

Esbonio Project Logo

Esbonio

pre-commit.ci status

esbonio - (v.) to explain

Esbonio aims to make it easier to work with reStructuredText tools such as Sphinx by providing a Language Server to enhance your editing experience. The Esbonio project is made up from a number of sub-projects

lib/esbonio/ - A Language Server for Sphinx projects.

PyPIPyPI - DownloadsLicense: MIT

The language server provides the following features.

Completion

Completion Suggestions Demo

Definitions

Goto Definition Demo

Diagnostics

Diagnostics Demo

Document Links

Document Links Demo

Document & Workspace Symbols

Document & Workspace Symbols Demo

Hover

Hover Demo

Implementations

Implementations Demo

code/ - A VSCode extension for editing Sphinx projects

Visual Studio Marketplace VersionVisual Studio Marketplace InstallsVisual Studio Marketplace DownloadsLicense: MIT

HTML Preview Demo

This extension integrates the esbonio language server into VSCode, it's primary goal is to expose all of the features provided by the language server and serve as a reference for integrating esbonio into other editors. Features that cannot be implemented primarily within the language server itself are out of scope for this extension.

For that reason, the Esbonio extension tries to integrate into the wider VSCode ecosystem where possible.

Dependent Extensions

Esbonio depends on the following extensions

  • By default, Esbonio relies on the offical Python Extension to configure the environment in which it builds your documentation.

  • The MyST Syntax Highlighting extension provides syntax highlighting rules for MyST flavoured markdown.

Supplementry Extensions

The the following extensions are not required in order to use Esbonio, but you might find them useful

  • The reStructuredText integrates many other useful tools such as the traditional linters like doc8 and rstcheck. It also provides additional editor functionality for working with reStructuredText in general.

  • While VSCode has included a vendored copy of the reStructuredText Syntax highlighting extension since v1.66, installing the extension from the marketplace will provide you with the latest version of the syntax definition.

lib/esbonio-extensions/ - A collection of Sphinx extensions

PyPIPyPI - DownloadsLicense: MIT