![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/)
> **Important**
>
> The `0.16.x` version of the language server is no longer in active development, all new users are encouraged to start with the `1.0bx` version.
>
> Existing users are also encouraged to [migrate](https://docs.esbon.io/en/latest/lsp/howto/migrate-to-v1.html), unless you are relying on a feature not yet provided by the `1.0bx` version.
> (See [this issue](https://github.com/swyddfa/esbonio/issues/901) for the latest status)
>
> The `1.0` version of the language server will be released once the remaining features from `0.16.x` have been ported across.
## Features
### Completion
![Completion Demo](https://github.com/swyddfa/esbonio/raw/0.x/resources/images/completion-demo.gif)
### Definitions
![Definition Demo](https://github.com/swyddfa/esbonio/raw/0.x/resources/images/definition-demo.gif)
### Diagnostics
![Diagnostics Demo](https://github.com/swyddfa/esbonio/raw/0.x/resources/images/diagnostic-sphinx-errors-demo.png)
### Document Links
![Document Link Demo](https://github.com/swyddfa/esbonio/raw/0.x/resources/images/document-links-demo.png)
### Document Symbols
![Document Symbols](https://github.com/swyddfa/esbonio/raw/0.x/resources/images/document-symbols-demo.png)
### Hover
![Hover Demo](https://github.com/swyddfa/esbonio/raw/0.x/resources/images/hover-demo.png)
### Implementations
![Implementations Demo](https://github.com/swyddfa/esbonio/raw/0.x/resources/images/implementation-demo.gif)
## Installation
The Language Server can be installed via pip.
Be sure to check out the [Getting Started](https://docs.esbon.io/en/esbonio-language-server-v0.16.4/lsp/getting-started.html) guide for details on integrating the server with your editor of choice.
```
$ pip install esbonio
```
Raw data
{
"_id": null,
"home_page": "https://docs.esbon.io/en/esbonio-language-server-v0.16.5/",
"name": "esbonio",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": null,
"keywords": null,
"author": "Alex Carney",
"author_email": "alcarneyme@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/67/c5/0c89af3da1f3133b53f3ba8ae677ed4d4ddff33eec50dbf32c95e01ed2d2/esbonio-0.16.5.tar.gz",
"platform": "any",
"description": "![Esbonio logo](https://github.com/swyddfa/esbonio/blob/release/resources/io.github.swyddfa.Esbonio.svg?raw=true)\n# Esbonio\n\n[![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)\n\n**esbonio - (v.) to explain**\n\nA [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/)\n\n> **Important**\n>\n> The `0.16.x` version of the language server is no longer in active development, all new users are encouraged to start with the `1.0bx` version.\n>\n> Existing users are also encouraged to [migrate](https://docs.esbon.io/en/latest/lsp/howto/migrate-to-v1.html), unless you are relying on a feature not yet provided by the `1.0bx` version.\n> (See [this issue](https://github.com/swyddfa/esbonio/issues/901) for the latest status)\n>\n> The `1.0` version of the language server will be released once the remaining features from `0.16.x` have been ported across.\n\n## Features\n\n### Completion\n\n![Completion Demo](https://github.com/swyddfa/esbonio/raw/0.x/resources/images/completion-demo.gif)\n\n### Definitions\n\n![Definition Demo](https://github.com/swyddfa/esbonio/raw/0.x/resources/images/definition-demo.gif)\n\n\n### Diagnostics\n\n![Diagnostics Demo](https://github.com/swyddfa/esbonio/raw/0.x/resources/images/diagnostic-sphinx-errors-demo.png)\n\n### Document Links\n\n![Document Link Demo](https://github.com/swyddfa/esbonio/raw/0.x/resources/images/document-links-demo.png)\n\n### Document Symbols\n\n![Document Symbols](https://github.com/swyddfa/esbonio/raw/0.x/resources/images/document-symbols-demo.png)\n\n### Hover\n\n![Hover Demo](https://github.com/swyddfa/esbonio/raw/0.x/resources/images/hover-demo.png)\n\n### Implementations\n\n![Implementations Demo](https://github.com/swyddfa/esbonio/raw/0.x/resources/images/implementation-demo.gif)\n\n## Installation\n\nThe Language Server can be installed via pip.\n\nBe sure to check out the [Getting Started](https://docs.esbon.io/en/esbonio-language-server-v0.16.4/lsp/getting-started.html) guide for details on integrating the server with your editor of choice.\n\n```\n$ pip install esbonio\n```\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "A Language Server for Sphinx projects.",
"version": "0.16.5",
"project_urls": {
"Bug Tracker": "https://github.com/swyddfa/esbonio/issues",
"Documentation": "https://docs.esbon.io/en/esbonio-language-server-v0.16.5/",
"Homepage": "https://docs.esbon.io/en/esbonio-language-server-v0.16.5/",
"Source Code": "https://github.com/swyddfa/esbonio"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "d8caa0296fca375d4324f471bb34d2ce8a585b48fb9eae21cf9abe00913eb899",
"md5": "8cf2531b2ba4a13db27bf0a6e1ac9674",
"sha256": "04ba926e3603f7b1fde1abc690b47afd60749b64b1029b6bce8e1de0bb284921"
},
"downloads": -1,
"filename": "esbonio-0.16.5-py3-none-any.whl",
"has_sig": false,
"md5_digest": "8cf2531b2ba4a13db27bf0a6e1ac9674",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 170830,
"upload_time": "2024-09-23T18:57:56",
"upload_time_iso_8601": "2024-09-23T18:57:56.568678Z",
"url": "https://files.pythonhosted.org/packages/d8/ca/a0296fca375d4324f471bb34d2ce8a585b48fb9eae21cf9abe00913eb899/esbonio-0.16.5-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "67c50c89af3da1f3133b53f3ba8ae677ed4d4ddff33eec50dbf32c95e01ed2d2",
"md5": "29295bde8520172fd72244f011dccef7",
"sha256": "acab2e16c6cf8f7232fb04e0d48514ce50566516b1f6fcf669ccf2f247e8b10f"
},
"downloads": -1,
"filename": "esbonio-0.16.5.tar.gz",
"has_sig": false,
"md5_digest": "29295bde8520172fd72244f011dccef7",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 145347,
"upload_time": "2024-09-23T18:57:57",
"upload_time_iso_8601": "2024-09-23T18:57:57.823389Z",
"url": "https://files.pythonhosted.org/packages/67/c5/0c89af3da1f3133b53f3ba8ae677ed4d4ddff33eec50dbf32c95e01ed2d2/esbonio-0.16.5.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-09-23 18:57:57",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "swyddfa",
"github_project": "esbonio",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "esbonio"
}