From dc59da70a9e6220d72c53999a8c99ce99b6a5372 Mon Sep 17 00:00:00 2001 From: gnikit Date: Sat, 5 Feb 2022 00:32:06 +0000 Subject: [PATCH] Updates documentation --- README.md | 10 ++++++++++ docs/fortls.rst | 8 ++++++++ docs/index.rst | 2 +- docs/requirements.txt | 7 ------- 4 files changed, 19 insertions(+), 8 deletions(-) delete mode 100644 docs/requirements.txt diff --git a/README.md b/README.md index 5d17ed54..9f2ae2ee 100644 --- 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 index 7db02e75..abce150e 100644 --- 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 index 418af573..75188632 100644 --- 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 deleted file mode 100644 index fd39737a..00000000 --- a/docs/requirements.txt +++ /dev/null @@ -1,7 +0,0 @@ -docutils -myst-parser -sphinx -sphinx_autodoc_typehints -sphinx_rtd_theme -sphinxprettysearchresults -sphinx-argparse \ No newline at end of file