Metadata-Version: 2.1
Name: esbonio
Version: 1.0.0b1
Summary: A language server for sphinx/docutils based documentation projects.
Project-URL: Bug Tracker, https://github.com/swyddfa/esbonio/issues
Project-URL: Documentation, https://swyddfa.github.io/esbonio/
Project-URL: Source Code, https://github.com/swyddfa/esbonio
Author-email: Alex Carney <alcarneyme@gmail.com>
License: MIT
License-File: LICENSE
Classifier: Development Status :: 3 - Alpha
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Topic :: Documentation
Classifier: Topic :: Documentation :: Sphinx
Requires-Python: >=3.8
Requires-Dist: aiosqlite
Requires-Dist: docutils
Requires-Dist: platformdirs
Requires-Dist: pygls>=1.1.0
Requires-Dist: tomli; python_version < '3.11'
Requires-Dist: websockets
Provides-Extra: dev
Requires-Dist: black; extra == 'dev'
Requires-Dist: flake8; extra == 'dev'
Requires-Dist: pre-commit; extra == 'dev'
Requires-Dist: tox; extra == 'dev'
Provides-Extra: typecheck
Requires-Dist: mypy; extra == 'typecheck'
Requires-Dist: pytest-lsp>=0.3.1; extra == 'typecheck'
Requires-Dist: types-docutils; extra == 'typecheck'
Requires-Dist: types-pygments; extra == 'typecheck'
Description-Content-Type: text/markdown

![Esbonio logo](https://github.com/swyddfa/esbonio/blob/release/resources/io.github.swyddfa.Esbonio.svg?raw=true)
# Esbonio

[![PyPI](https://img.shields.io/pypi/v/esbonio?style=flat-square)](https://pypi.org/project/esbonio)[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/esbonio?style=flat-square)](https://pypi.org/project/esbonio)![PyPI - Downloads](https://img.shields.io/pypi/dm/esbonio?style=flat-square)[![License: MIT](https://img.shields.io/badge/license-MIT-blue.svg?style=flat-square)](https://github.com/swyddfa/esbonio/blob/develop/lib/esbonio/LICENSE)

**esbonio - (v.) to explain**

A [Language Server](https://microsoft.github.io/language-server-protocol/) that aims to make it easier to work with [reStructuredText](https://docutils.sourceforge.io/rst.html) tools such as [Sphinx](https://www.sphinx-doc.org/en/master/)

The language server provides the following features

## Completion

![Completion Demo](https://github.com/swyddfa/esbonio/raw/release/resources/images/completion-demo.gif)

## Definitions

![Definition Demo](https://github.com/swyddfa/esbonio/raw/release/resources/images/definition-demo.gif)


## Diagnostics

![Diagnostics Demo](https://github.com/swyddfa/esbonio/raw/release/resources/images/diagnostic-sphinx-errors-demo.png)

## Document Links

![Document Link Demo](https://github.com/swyddfa/esbonio/raw/release/resources/images/document-links-demo.png)

## Document & Workspace Symbols

![Document & Workspace Symbol Demo](https://github.com/swyddfa/esbonio/raw/release/resources/images/document-workspace-symbols-demo.png)

## Hover

![Hover Demo](https://github.com/swyddfa/esbonio/raw/release/resources/images/hover-demo.png)

## Implementations

![Implementations Demo](https://github.com/swyddfa/esbonio/raw/release/resources/images/implementation-demo.gif)

## Installation

It's recommended to install the language server with [`pipx`](https://pipx.pypa.io/stable/)

Be sure to check out the [Getting Started](https://docs.esbon.io/latest/en/lsp/getting-started.html) guide for details on integrating the server with your editor of choice.

```
$ pipx install esbonio
```
