Updated setup.cfg and docs

Author: gnikit

CHANGELOG.md

@@ -1,5 +1,12 @@
 # CHANGELONG
 
+## 2.2.5
+
+### Changed
+
+- Updated `setup.cfg` in preparation of submitting package to `conda-forge`
+- Added `Editor Integration` section in documentation
+
 ## 2.2.4
 
 ### Fixed

README.md

@@ -1,4 +1,4 @@
-# fortls - the Fortran Language Server
+# fortls - Fortran Language Server
 
 ![PyPI](https://img.shields.io/pypi/v/fortls)
 ![PyPI - Python Version](https://img.shields.io/pypi/pyversions/fortls)
@@ -11,15 +11,17 @@
 `fortls` is an implementation of the [Language Server Protocol](https://github.com/Microsoft/language-server-protocol)
 (LSP) for Fortran using Python (3.7+).
 
-Editor extensions that can integrate with `fortls` to provide autocomplete and
-other IDE-like functionality are available for
-[Visual Studio Code](https://github.com/krvajal/vscode-fortran-support),
-[Atom](https://atom.io/packages/ide-fortran),
-[Visual Studio](https://github.com/michaelkonecny/vs-fortran-ls-client),
-[(Neo)vim](https://github.com/hansec/fortran-language-server/wiki/Using-forts-with-vim),
-and [Emacs](https://github.com/emacs-lsp/lsp-mode).
+All code editors that support LSP can integrate with `fortls` see the section
+[Editor Integration](https://gnikit.github.io/fortls/editor_integration.html#editor-integration) in the documentation.
+Some supported code editors include:
+[Visual Studio Code](https://gnikit.github.io/fortls/editor_integration.html#visual-studio-code),
+[Atom](https://gnikit.github.io/fortls/editor_integration.html#atom),
+[Sublime Text](https://gnikit.github.io/fortls/editor_integration.html#sublime-text)
+[(Neo)Vim](https://gnikit.github.io/fortls/editor_integration.html#vim-neovim-gvim),
+[Visual Studio](https://gnikit.github.io/fortls/editor_integration.html#visual-studio-2017),
+and [Emacs](https://gnikit.github.io/fortls/editor_integration.html#emacs).
 
-## fortls vs fortran-language-server
+## `fortls` vs `fortran-language-server`
 
 This project is based on @hansec's original Language Server implementation but the two projects have since diverged.
 `fortls` (this project) is now developed independently of the upstream `hansec/fortran-language-server` project and contains numerous bug fixes and new features
@@ -56,32 +58,30 @@ potentially subject to change.
   - Invalid scope nesting
   - Unknown modules in `USE` statement
   - Unimplemented deferred type-bound procedures
-  - Use of unimported variables/objects in interface blocks
+  - Use of non-imported variables/objects in interface blocks
   - Statement placement errors (`CONTAINS`, `IMPLICIT`, `IMPORT`)
-- Code actions (`textDocument/codeAction`) \[Experimental\]
+- Code actions
   - Generate type-bound procedures and implementation templates for
     deferred procedures
 
 ### Notes/Limitations
 
-- Signature help is not available for overloaded subroutines/functions
-- Diagnostics are only updated when files are saved or opened/closed
+- Signature help and hover does not handle elegantly overloaded functions i.e. interfaces
 
 ## Installation
 
 ```sh
 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`.
+> **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
->```
-
+> ```sh
+> pip uninstall fortran-language-server
+> pip install fortls --upgrade
+> ```
 
 ## Settings
 
@@ -115,9 +115,15 @@ An example for a Configuration file is given below
 | `textDocument/documentSymbol` | Get document symbols e.g. functions, subroutines, etc. |
 | `textDocument/completion`     | Suggested tab-completion when typing                   |
 | `textDocument/signatureHelp`  | Get signature information at a given cursor position   |
-| `textDocument/definition`     | GoTo implementation/Peek implementation                |
+| `textDocument/definition`     | GoTo definition/Peek definition                        |
 | `textDocument/references`     | Find all/Peek references                               |
+| `textDocument/hover`          | Show messages and signatures upon hover                |
+| `textDocument/implementation` | GoTo implementation/Peek implementation                |
 | `textDocument/rename`         | Rename a symbol across the workspace                   |
+| `textDocument/didOpen`        | Document synchronisation upon opening                  |
+| `textDocument/didSave`        | Document synchronisation upon saving                   |
+| `textDocument/didClose`       | Document synchronisation upon closing                  |
+| `textDocument/didChange`      | Document synchronisation upon changes to the document  |
 | `textDocument/codeAction`     | **Experimental** Generate code                         |
 
 ## Acknowledgements

docs/editor_integration.rst

@@ -0,0 +1,98 @@
+Editor Integration
+===================
+
+Visual Studio Code
+------------------
+
+The Language Server is natively supported through the `Modern Fortran`_ extension.
+Install ``fortls`` then install the extension and all of the server's features should be instantly available.
+
+.. _Modern Fortran: https://marketplace.visualstudio.com/items?itemName=krvajalm.linter-gfortran
+
+.. note::
+    Make sure that ``fortls`` is reachable in your ``$PATH``. If not you can specify the option
+    ``"fortran.fortls.path": "/custom/path/to/fortls"``
+
+Atom
+----
+
+Firstly ``fortls`` then install the `language-fortran`_ plugin by `@dparkins`_ to get Fortran syntax highlighting.
+Finally, install either `fortran-lsp`_ by `@gnikit`_ or `ide-fortran`_ by `@hansec`_
+
+.. warning::
+    `fortran-lsp`_ has been created solely for the ``fortls`` Language Server, hence it natively interfaces with ``fortls``.
+    `ide-fortran`_ was created for an older, now deprecated, Fortran Language Server hence the options
+    available through the extension are not representative of ``fortls``'s interface.
+
+.. _language-fortran: https://atom.io/packages/language-fortran
+.. _@dparkins: https://github.com/dparkins
+.. _fortran-lsp: https://atom.io/packages/fortran-lsp
+.. _@gnikit: https://github.com/gnikit
+.. _ide-fortran: https://atom.io/packages/ide-fortran
+.. _@hansec: https://github.com/hansec
+
+Sublime Text
+------------
+
+Firstly, install ``fortls`` then install the `LSP`_ package from package control.
+Finally, install the `Fortran`_ package and add the following in your configuration
+
+.. code-block:: json
+
+    {
+        "clients": {
+            "fortls": {
+                "enabled": true,
+                "command": ["fortls", "--notify_init"],
+                "selector": "source.modern-fortran | source.fixedform-fortran"
+            }
+        }
+    }
+
+For more details see the LSP `documentation`_.
+
+.. _LSP: https://github.com/sublimelsp/LSP
+.. _Fortran: https://packagecontrol.io/packages/Fortran
+.. _documentation: https://lsp.sublimetext.io/language_servers/#fortran
+
+
+Vim, Neovim, GVim
+-----------------
+
+Firstly install the plugin `LanguageClient-neovim`_. Then edit your ``~/.vimrc`` settings file
+to set ``fortls`` for Fortran files
+
+.. code-block:: vim
+
+    " Required for operations modifying multiple buffers like rename. set hidden
+    let g:LanguageClient_serverCommands = {
+        " Add any default arguments you want fortls to have inside []
+        \ 'fortls': ['--hover_signature', '--use_signature_help'],
+        \ }
+
+    " note that if you are using Plug mapping you should not use `noremap` mappings.
+    nmap <F5> <Plug>(lcn-menu)
+    " Or map each action separately
+    nmap <silent>K <Plug>(lcn-hover)
+    nmap <silent> gd <Plug>(lcn-definition)
+    nmap <silent> <F2> <Plug>(lcn-rename)
+
+.. _LanguageClient-neovim: https://github.com/autozimu/LanguageClient-neovim
+
+EMACS
+-----
+
+Install the `lsp-mode`_ plugin. This should then allow for the variables
+`lsp-clients-fortls-args`_ and `lsp-clients-fortls-executable`_ to be defined in the ``~/.emacs`` configuration file.
+
+.. _lsp-mode: https://emacs-lsp.github.io/lsp-mode/page/installation
+.. _lsp-clients-fortls-args: https://emacs-lsp.github.io/lsp-mode/page/lsp-fortran/#lsp-clients-fortls-args
+.. _lsp-clients-fortls-executable: https://emacs-lsp.github.io/lsp-mode/page/lsp-fortran/#lsp-clients-fortls-executable
+
+Visual Studio 2017
+------------------
+
+Installing this `VS17 extension`_ should enable ``fortls`` features in Visual Studio
+
+.. _VS17 extension: https://github.com/michaelkonecny/vs-fortran-ls-client
+

docs/index.rst

@@ -12,6 +12,7 @@ fortls -- Fortran Language Server
 
    README.md
    options.rst
+   editor_integration.rst
    fortls_changes.md
    modules.rst
 

setup.cfg

@@ -25,7 +25,8 @@ classifiers =
     Operating System :: Unix
     Operating System :: MacOS
 project_urls =
-    Source = https://github.com/gnikit/fortls
+    Documentation = https://gnikit.github.io/fortls
+    Repository = https://github.com/gnikit/fortls
     Tracker = https://github.com/gnikit/fortls/issues
 
 [options]
@@ -49,7 +50,7 @@ dev =
     black
     isort
 docs =
-    sphinx ~= 4.0.0
+    sphinx >= 4.0.0
     sphinx_rtd_theme
     sphinx-argparse
     sphinx-autodoc-typehints