esbonio
A language server for sphinx/docutils based documentation projects.
Decision gist · record as of 2026-08-14
Yes, if you work regularly with Sphinx or reStructuredText documentation and want IDE-like editing support. The package is actively maintained, has no known vulnerabilities, uses a permissive MIT license, and integrates cleanly with modern editors via LSP. Install via pipx to avoid dependency conflicts with your projects.AI-flagged interpretation of the facts on this page — verify before relying
Before you install
- Requires Python 3.10 or later.
- The language server must be integrated with an editor that supports the Language Server Protocol (LSP), such as VS Code, Neovim, or Emacs with appropriate LSP client support.
- Low install friction with a pure-Python wheel distribution.
License · maintenance · safety
MIT (permissive) — MIT license permits free use, modification, and distribution with minimal restrictions, making it suitable for both personal and commercial projects.
last release 2026-06-28 (47 days) · last repo commit 2026-08-09 · 182 stars
0 known vulnerabilities (OSV.dev, 2026-08-14) · 223,708 downloads/mo, #9,241 on PyPI
Alternatives
Verify before relying
pip install esbonio
Then configure your editor to use esbonio as the language server for .rst files. For example, in VS Code with the reStructuredText extension, point the server executable to the esbonio binary installed by pip.- Specific editor integrations and configuration steps beyond the Getting Started guide documentation.
- Performance characteristics with large Sphinx projects or complex documentation hierarchies.
- Whether all Sphinx extensions are supported or if there are known limitations with certain extension types.
What it is and what it does
Esbonio is a Language Server Protocol server designed to bring IDE-like editing features to reStructuredText and Sphinx documentation projects. It runs as a background service that your editor connects to, providing real-time completion suggestions, error diagnostics, hover documentation, symbol navigation, and other language-aware features as you write documentation.
The server integrates with the docutils and Sphinx ecosystems, understanding the structure and semantics of reStructuredText markup. It depends on aiosqlite, platformdirs, pygls, tomli, websockets, and docutils to handle async database operations, configuration management, LSP protocol communication, and markup parsing. Installation via pipx is recommended to keep the server isolated from your project dependencies.
Use it for
- Writing Sphinx documentation with real-time error checking and completion for roles, directives, and cross-references.
- Editing reStructuredText files in an IDE with hover tooltips and symbol search across documentation projects.
- Validating documentation syntax and catching common mistakes before building or publishing.
- Navigating large documentation hierarchies by jumping to definitions and finding symbol references.
- Authoring API documentation with Sphinx autodoc while receiving intelligent suggestions for markup patterns.
Worth the install?
AI-flagged interpretation of the facts on this page. Verify before relying on it.
Yes, if you work regularly with Sphinx or reStructuredText documentation and want IDE-like editing support.
The package is actively maintained, has no known vulnerabilities, uses a permissive MIT license, and integrates cleanly with modern editors via LSP. Install via pipx to avoid dependency conflicts with your projects.
Install
esbonio on PyPI
Before you install
Low install friction with a pure-Python wheel distribution. Actively maintained with a recent release (47 days old) and steady repository activity. Supports current Python versions (3.10–3.14).
Requires Python 3.10 or later. The language server must be integrated with an editor that supports the Language Server Protocol (LSP), such as VS Code, Neovim, or Emacs with appropriate LSP client support.
License in practice
MIT license permits free use, modification, and distribution with minimal restrictions, making it suitable for both personal and commercial projects.
Quickstart
pip install esbonio
Then configure your editor to use esbonio as the language server for .rst files. For example, in VS Code with the reStructuredText extension, point the server executable to the esbonio binary installed by pip.Verify before relying
- Specific editor integrations and configuration steps beyond the Getting Started guide documentation.
- Performance characteristics with large Sphinx projects or complex documentation hierarchies.
- Whether all Sphinx extensions are supported or if there are known limitations with certain extension types.
Package facts
| License | MIT permissive |
| Python support | Supports the current Python release >=3.10 |
| Install friction | Low. Pure-Python wheel |
| Runtime dependencies | 6 packagesaiosqlitedocutilsplatformdirspyglstomliwebsockets |
| Maintenance | Actively maintained 47 days since the last release |
| Last repo commit | |
| First released | |
| Downloads | 223,708 / month, #9,241 on PyPI 30-day window, as of 2026-08-14 |
| Known vulnerabilities | None known OSV.dev, checked 2026-08-14 |
| Classifiers | Development Status :: 5 - Production/StableLicense :: OSI Approved :: MIT LicenseProgramming Language :: PythonProgramming Language :: Python :: 3Programming Language :: Python :: 3 :: OnlyProgramming Language :: Python :: 3.10Programming Language :: Python :: 3.11Programming Language :: Python :: 3.12Programming Language :: Python :: 3.13Programming Language :: Python :: 3.14Topic :: DocumentationTopic :: Documentation :: Sphinx |
Evidence: esbonio-2.1.0-py3-none-any.whl
Tags
Let your AI agent find packages like this
Example. Real query, live index.
You found this page by searching. An agent finds it by wishing: SkillFed indexes 14,416 PyPI packages by what they can do, searchable in plain language.
wish › “language server reStructuredText”
- esbonioA Language Server Protocol implementation for reStructuredText and…
- docutilsDocutils converts plaintext documentation in reStructuredText format…
- sphinxcontrib-confluencebuilderSphinx extension that converts reStructuredText documentation into…
Give your agent the search over MCP, or paste the wish link into any chat.
More Documentation packages
Docutils converts plaintext documentation in reStructuredText format into multiple output formats including HTML, XML, and LaTeX using a modular processing system.
Sphinx generates professional documentation from reStructuredText source files, producing HTML, PDF, EPUB, and other formats with automatic cross-references, code highlighting, and hierarchical navigation.
Griffe extracts the complete structure and signatures of Python programs to generate API documentation or detect breaking changes in your project's public API.
Install it if you need to programmatically inspect Python code structure, generate API docs, or enforce API stability in CI.
A Sphinx extension that outputs documentation in serialized HTML formats (JSON and pickle) alongside standard HTML.
Alabaster is a clean, responsive Sphinx theme for documentation that requires Python 3.10 or newer and Sphinx 6.2 or newer.
A Sphinx extension that generates HTML help files from reStructuredText documentation source.
See also recommonmark · docstrfmt · jedi-language-server · ruff-lsp · m2r2 · pygls · rich-rst · sphinx_mdinclude · xbsl