Skip to content

Commit dc59da7

Browse files
committed
Updates documentation
1 parent 9cb5a2f commit dc59da7

File tree

4 files changed

+19
-8
lines changed

4 files changed

+19
-8
lines changed

README.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -73,6 +73,16 @@ potentially subject to change.
7373
pip install fortls
7474
```
7575

76+
>**Warning**: it is not recommended having `fortls` and `fortran-language-server`
77+
>simultaneously installed, since they use the same binary name. If you are having trouble
78+
>getting `fortls` to work try uninstalling `fortran-language-server` and reinstalling `fortls`.
79+
>
80+
>```sh
81+
>pip uninstall fortran-language-server
82+
>pip install fortls --upgrade
83+
>```
84+
85+
7686
## Settings
7787
7888
`fortls` can be configured through both the command line e.g.

docs/fortls.rst

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -76,6 +76,14 @@ fortls.regex\_patterns module
7676
:undoc-members:
7777
:show-inheritance:
7878

79+
fortls.version module
80+
---------------------
81+
82+
.. automodule:: fortls.version
83+
:members:
84+
:undoc-members:
85+
:show-inheritance:
86+
7987
Module contents
8088
---------------
8189

docs/index.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
You can adapt this file completely to your liking, but it should at least
44
contain the root `toctree` directive.
55
6-
fortls
6+
fortls -- Fortran Language Server
77
==================================
88

99
.. toctree::

docs/requirements.txt

Lines changed: 0 additions & 7 deletions
This file was deleted.

0 commit comments

Comments
 (0)