diff options
Diffstat (limited to 'docs/source/index.rst')
| -rw-r--r-- | docs/source/index.rst | 51 |
1 files changed, 51 insertions, 0 deletions
diff --git a/docs/source/index.rst b/docs/source/index.rst new file mode 100644 index 0000000..3fc264c --- /dev/null +++ b/docs/source/index.rst @@ -0,0 +1,51 @@ +.. pygls documentation master file, created by + sphinx-quickstart on Sun Nov 25 16:16:27 2018. + You can adapt this file completely to your liking, but it should at least + contain the root `toctree` directive. + +*pygls* +======= + +`pygls`_ (pronounced like “pie glass”) is a generic implementation of +the `Language Server Protocol`_ written in the Python programming language. It +allows you to write your own `language server`_ in just a few lines of code. + +Features +-------- + +- cross-platform support +- TCP/IP and STDIO communication +- runs in asyncio event loop +- register LSP features and custom commands as: + + - asynchronous functions (coroutines) + - synchronous functions + - functions that will be executed in separate thread + +- thread management +- in-memory workspace with *full* and *incremental* document updates +- type-checking +- good test coverage + +Python Versions +--------------- + +*pygls* works with Python 3.8+. + +User Guide +---------- + +.. toctree:: + :maxdepth: 2 + + pages/getting_started + pages/tutorial + pages/user-guide + pages/testing + pages/migrating-to-v1 + pages/reference + + +.. _Language Server Protocol: https://microsoft.github.io/language-server-protocol/specification +.. _Language server: https://langserver.org/ +.. _pygls: https://github.com/openlawlibrary/pygls |