esbonio

library2.0.0pypypi✓ verified 82d ago

A language server for Sphinx and docutils-based documentation projects. Current version: 2.0.0. Release cadence: irregular, with major version bumps every few years.

web-framework

pip install esbonio

github ↗package ↗docs ↗

INSTALL

IMPORT

SIG · ESBONIO

esbonio

web-frameworkpythonv2.0.0

Install

3.4s avg

Import

—

Disk

42MB

Pass rate

10/ 10

Env Coverage10 / 10

glibc

3.9–3.13

musl

3.9–3.13

Install & Compatibility

Where this runs

tested against v2.0.0 · pip install

no network on importno background threads

Install × environment matrix

Each cell = how many times install + import succeeded across repeated harness runs. Partial = flaky.
glibc = Debian/Ubuntu slim · musl = Alpine Linux

musl

py 3.10–3.910 runs

installs and imports cleanly · install 0.0s · import 0.000s · 28.5MB

glibc

py 3.10–3.910 runs

installs and imports cleanly · install 3.4s · import 0.000s · 29MB

42MB installed

● package 42MB

Code

Verified usage

Verified import paths — ran on the pinned version, not inferred.

EsbonioServer

✓ import esbonio

✗ from esbonio import EsbonioServer

Create a basic Esbonio server instance.

from esbonio.server import EsbonioServer server = EsbonioServer() print(server.version_info)

esbonio --version

Debug

Known issues

breakingIn v2.0, the top-level module exports were reorganized. `from esbonio import X` no longer works for server-related symbols. Use `from esbonio.server import X` instead.

fix

Update all imports to use 'esbonio.server' submodule for server classes.

affects: <=1.x

deprecatedThe `esbonio.lsp` module is deprecated in v2.0 and will be removed in a future version. Migrate to `esbonio.server`.

fix

Replace 'from esbonio.lsp import ...' with 'from esbonio.server import ...'.

affects: >=2.0.0,<3.0.0

gotchaEsbonio requires a Sphinx project directory to function; running outside a project root causes cryptic errors like "Unknown config". Ensure you are in a directory with conf.py.

fix

Run the language server from your Sphinx project root, or set the 'workspaceFolders' in LSP client.

affects: all

gotchaIn v2.0, the default Python requirement changed to >=3.10. Using older Python versions will cause installation failures.

fix

Upgrade Python to 3.10 or later, or pin esbonio to 1.x if you must use an older Python.

affects: >=2.0.0

Upgrade

Version history

2.0.0latest on PyPI · released Apr 11, 2026

Audit

Dependencies

sphinxrequiredRequired for Sphinx support

pyglsrequiredLSP protocol implementation

docutilsoptionalRequired for docutils support

Agent activity

4 hits · last 30 days

node

Resources

githubhttps://github.com/swyddfa/esbonio ↗

packagehttps://pypi.org/project/esbonio/ ↗

docshttps://swyddfa.github.io/esbonio/ ↗