Merge pull request #212 from krassowski/docs/links_to_language_servers

Add documentation links in LANGUAGESERVERS & README

Author: krassowski

CONTRIBUTING.md

@@ -16,7 +16,7 @@ You can contribute to the project through:
 - proposing parts of the architecture that can be [extended][extending]
 - improving [documentation](#Documentation)
 - tackling Big Issues from the [future roadmap][roadmap]
-- improving [testing](#Testing)
+- improving testing
 - reviewing pull requests
 
 [license]: https://github.com/krassowski/jupyterlab-lsp/blob/master/LICENSE
@@ -164,7 +164,7 @@ is recommended to peruse the [Robot Framework User's Guide][rfug] (and the exist
 First, ensure you've prepared JupyterLab for `jupyterlab-lsp`
 [frontend](#frontend-development) and [server](#server-development) development.
 
-Prepare the enviroment:
+Prepare the environment:
 
 ```bash
 conda env update -n jupyterlab-lsp --file requirements/atest.yml
@@ -260,7 +260,7 @@ python scripts/combine.py
 - If a test suite for a specific language fails it may indicate that you have no
   appropriate server language installed (see [LANGUAGESERVERS][])
 
-[languageservers]: ./docs/Language%20Servers.ipynb
+[languageservers]: https://jupyterlab-lsp.readthedocs.io/en/latest/Language%20Servers.html
 
 - If you are seeing errors like `Element is blocked by .jp-Dialog`, caused by
   the JupyterLab _Build suggested_ dialog, (likely if you have been using

LANGUAGESERVERS.md

@@ -1 +1 @@
-This file has moved to [docs/LANGUAGESERVERS.md](./docs/Configuring.ipynb).
+This file has moved to the documentation: [Language Servers](https://jupyterlab-lsp.readthedocs.io/en/latest/Language%20Servers.html) and [Configuring](https://jupyterlab-lsp.readthedocs.io/en/latest/Configuring.html) sections.

README.md

@@ -1,14 +1,14 @@
 # Language Server Protocol integration for Jupyter(Lab)
 
-[![Build Status](https://travis-ci.org/krassowski/jupyterlab-lsp.svg?branch=master)](https://travis-ci.org/krassowski/jupyterlab-lsp) [![Build Status](https://dev.azure.com/krassowskimichal/jupyterlab-lsp/_apis/build/status/jupyterlab-lsp?branchName=master)](https://dev.azure.com/krassowskimichal/jupyterlab-lsp/_build/latest?definitionId=1&branchName=master) [![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/krassowski/jupyterlab-lsp/master?urlpath=lab%2Ftree%2Fexamples%2FPython.ipynb)
+[![Build Status](https://travis-ci.org/krassowski/jupyterlab-lsp.svg?branch=master)](https://travis-ci.org/krassowski/jupyterlab-lsp) [![Build Status](https://dev.azure.com/krassowskimichal/jupyterlab-lsp/_apis/build/status/jupyterlab-lsp?branchName=master)](https://dev.azure.com/krassowskimichal/jupyterlab-lsp/_build/latest?definitionId=1&branchName=master) [![Documentation Status](https://readthedocs.org/projects/jupyterlab-lsp/badge/?version=latest)](https://jupyterlab-lsp.readthedocs.io/en/latest/?badge=latest) [![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/krassowski/jupyterlab-lsp/master?urlpath=lab%2Ftree%2Fexamples%2FPython.ipynb)
 
 > _This project is still maturing, but you are welcome to check it out, leave feedback and/or a PR_
 
 Quick Links: **[Installation](#installation) | [Configuring](./docs/Configuring.ipynb) | [Updating](#updating) | [Changelog](./CHANGELOG.md) | [Roadmap](./docs/Roadmap.ipynb) | [Contributing](./CONTRIBUTING.md) | [Extending](./docs/Extending.ipynb)**
 
 ## Features
 
-> Examples show Python code, but most features also work in R, bash, typescript, and [many other languages](./docs/Language Servers.ipynb).
+> Examples show Python code, but most features also work in R, bash, typescript, and [many other languages][language-servers].
 
 ### Hover
 
@@ -86,7 +86,7 @@ And:
 
 ## Installation
 
-> For more extensive installation instructions, see the [documentation](./docs/Installation.ipynb).
+> For more extensive installation instructions, see the [documentation][installation-documentation].
 
 For the current stable version, the following steps are recommended.
 Use of a python `virtualenv` or a conda env is also recommended.
@@ -147,7 +147,7 @@ Use of a python `virtualenv` or a conda env is also recommended.
    ```
 
    Please see our full list of
-   [supported language servers](./docs/LANGUAGESERVERS.md)
+   [supported language servers][language-servers]
    which includes installation hints for the common package managers (npm/pip/conda).
    In general, any LSP server from the
    [Microsoft list](https://microsoft.github.io/language-server-protocol/implementors/servers/)
@@ -192,7 +192,7 @@ jupyter labextension install @krassowski/[email protected]
 
 ### Configuring the servers
 
-We plan to provide a configuration GUI at some time ([#25](https://github.com/krassowski/jupyterlab-lsp/issues/25)), but in the meantime, you can use the instructions for the specific servers as described on their websites (see the table in [LANGUAGESERVERS.md](./docs/LANGUAGESERVERS.md) for links).
+We plan to provide a configuration GUI at some time ([#25](https://github.com/krassowski/jupyterlab-lsp/issues/25)), but in the meantime, you can use the instructions for the specific servers as described on their websites (see the [table of language servers][language-servers] for links).
 
 #### I want to hide specific diagnostics/inspections/warnings
 
@@ -220,3 +220,6 @@ Again, please do check the pycodestyle documentation for specific error codes, a
 
 This would not be possible without the fantastic initial work at
 [wylieconlon/lsp-editor-adapter](https://github.com/wylieconlon/lsp-editor-adapter).
+
+[language-servers]: https://jupyterlab-lsp.readthedocs.io/en/latest/Language%20Servers.html
+[installation-documentation]: https://jupyterlab-lsp.readthedocs.io/en/latest/Installation.html