Updates documentation

fortran-lang · Feb 5, 2022 · dc59da7 · dc59da7
1 parent 9cb5a2f
commit dc59da7
Show file tree

Hide file tree

Showing 4 changed files with 19 additions and 8 deletions.
diff --git a/README.md b/README.md
@@ -73,6 +73,16 @@ potentially subject to change.
 pip install fortls
 ```
 
+>**Warning**: it is not recommended having `fortls` and `fortran-language-server`
+>simultaneously installed, since they use the same binary name. If you are having trouble
+>getting `fortls` to work try uninstalling `fortran-language-server` and reinstalling `fortls`.
+>
+>```sh
+>pip uninstall fortran-language-server
+>pip install fortls --upgrade
+>```
+
+
 ## Settings
 
 `fortls` can be configured through both the command line e.g.

diff --git a/docs/fortls.rst b/docs/fortls.rst
@@ -76,6 +76,14 @@ fortls.regex\_patterns module
    :undoc-members:
    :show-inheritance:
 
+fortls.version module
+---------------------
+
+.. automodule:: fortls.version
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
 Module contents
 ---------------
 

diff --git a/docs/index.rst b/docs/index.rst
@@ -3,7 +3,7 @@
    You can adapt this file completely to your liking, but it should at least
    contain the root `toctree` directive.
 
-fortls
+fortls -- Fortran Language Server
 ==================================
 
 .. toctree::

diff --git a/docs/requirements.txt b/docs/requirements.txt