99 lines
4.0 KiB
Plaintext
99 lines
4.0 KiB
Plaintext
|
Metadata-Version: 2.1
|
||
|
|
Name: esbonio
|
||
|
|
Version: 0.16.2
|
||
|
|
Summary: A Language Server for Sphinx projects.
|
||
|
|
Home-page: https://swyddfa.github.io/esbonio/
|
||
|
|
Author: Alex Carney
|
||
|
|
Author-email: alcarneyme@gmail.com
|
||
|
|
License: MIT
|
||
|
|
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
|
||
|
|
Platform: any
|
||
|
|
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.7
|
||
|
|
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: Topic :: Documentation
|
||
|
|
Classifier: Topic :: Documentation :: Sphinx
|
||
|
|
Requires-Python: >=3.7
|
||
|
|
Description-Content-Type: text/markdown
|
||
|
|
License-File: LICENSE
|
||
|
|
Requires-Dist: sphinx
|
||
|
|
Requires-Dist: platformdirs
|
||
|
|
Requires-Dist: pygls >=1.1.0
|
||
|
|
Requires-Dist: pyspellchecker
|
||
|
|
Requires-Dist: typing-extensions ; python_version < "3.8"
|
||
|
|
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: test
|
||
|
|
Requires-Dist: pytest ; extra == 'test'
|
||
|
|
Requires-Dist: pytest-lsp >=0.3.1 ; extra == 'test'
|
||
|
|
Requires-Dist: pytest-cov ; extra == 'test'
|
||
|
|
Requires-Dist: pytest-timeout ; extra == 'test'
|
||
|
|
Requires-Dist: mock ; (python_version < "3.8") and extra == 'test'
|
||
|
|
Provides-Extra: typecheck
|
||
|
|
Requires-Dist: mypy ; extra == 'typecheck'
|
||
|
|
Requires-Dist: pytest-lsp >=0.3.1 ; extra == 'typecheck'
|
||
|
|
Requires-Dist: types-appdirs ; extra == 'typecheck'
|
||
|
|
Requires-Dist: types-docutils ; extra == 'typecheck'
|
||
|
|
Requires-Dist: types-pygments ; extra == 'typecheck'
|
||
|
|
|
||
|
|
|
||
|
|
# Esbonio
|
||
|
|
|
||
|
|
[](https://pypi.org/project/esbonio)[](https://pypi.org/project/esbonio)[](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/)
|
||
|
|
|
||
|
|
It's still in early development, but already provides the following features.
|
||
|
|
|
||
|
|
## Completion
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
## Definitions
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
## Diagnostics
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
## Document Links
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
## Document Symbols
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
## Hover
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
## Implementations
|
||
|
|
|
||
|
|
|
||
|
|
## Installation
|
||
|
|
|
||
|
|
The Language Server can be installed via pip.
|
||
|
|
|
||
|
|
Be sure to check out the [Getting Started](https://swyddfa.github.io/esbonio/docs/latest/en/lsp/getting-started.html) guide for details on integrating the server with your editor of choice.
|
||
|
|
|
||
|
|
```
|
||
|
|
$ pip install esbonio
|
||
|
|
```
|