From f952d4e9cc62728f1dba2d5cfa29192f91baae20 Mon Sep 17 00:00:00 2001 From: gnikit Date: Fri, 26 Apr 2024 01:54:19 +0100 Subject: [PATCH 1/2] docs: moved section towards the end --- README.md | 28 ++++++++++++++-------------- 1 file changed, 14 insertions(+), 14 deletions(-) diff --git a/README.md b/README.md index a652e3bb..a5af329d 100644 --- a/README.md +++ b/README.md @@ -65,20 +65,6 @@ and [Emacs](https://fortls.fortran-lang.org/editor_integration.html#emacs). - Signature help and hover does not handle elegantly overloaded functions i.e. interfaces -## `fortls` vs `fortran-language-server` - -This project was originally based on `fortran-language-server` LSP 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 new features and bug fixes -the original `fortran-language-server` does not. - -For a complete and detailed list of the differences between the two Language Servers -see the Documentation section: [Unique fortls features (not in fortran-language-server)](https://fortls.fortran-lang.org/fortls_changes.html) - -The name of executable for this project has been chosen to remain `fortls` -to allow for integration with pre-existing plugins and workflows, but it could -change in the future. - ## Future plans `fortls` has reached a point where it is feature complete and stable enough to be used in many modern Fortran projects without any issues. @@ -176,6 +162,20 @@ An example for a Configuration file is given below | `textDocument/didChange` | Document synchronisation upon changes to the document | | `textDocument/codeAction` | **Experimental** Generate code | +## `fortls` vs `fortran-language-server` + +This project was originally based on `fortran-language-server` LSP 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 new features and bug fixes +the original `fortran-language-server` does not. + +For a complete and detailed list of the differences between the two Language Servers +see the Documentation section: [Unique fortls features (not in fortran-language-server)](https://fortls.fortran-lang.org/fortls_changes.html) + +The name of executable for this project has been chosen to remain `fortls` +to allow for integration with pre-existing plugins and workflows, but it could +change in the future. + ## Acknowledgements This project would not have been possible without the original work of [@hansec](https://github.com/hansec/) From f4f22f3c9cf8776a962000fdb26dcf8579db3080 Mon Sep 17 00:00:00 2001 From: gnikit Date: Fri, 26 Apr 2024 02:08:25 +0100 Subject: [PATCH 2/2] docs: update API docs --- docs/fortls.parsers.internal.rst | 221 +++++++++++++++++++++++++++++++ docs/fortls.parsers.rst | 18 +++ docs/fortls.rst | 44 +++--- 3 files changed, 261 insertions(+), 22 deletions(-) create mode 100644 docs/fortls.parsers.internal.rst create mode 100644 docs/fortls.parsers.rst diff --git a/docs/fortls.parsers.internal.rst b/docs/fortls.parsers.internal.rst new file mode 100644 index 00000000..bcde6ec9 --- /dev/null +++ b/docs/fortls.parsers.internal.rst @@ -0,0 +1,221 @@ +fortls.parsers.internal package +=============================== + +Submodules +---------- + +fortls.parsers.internal.associate module +---------------------------------------- + +.. automodule:: fortls.parsers.internal.associate + :members: + :undoc-members: + :show-inheritance: + +fortls.parsers.internal.ast module +---------------------------------- + +.. automodule:: fortls.parsers.internal.ast + :members: + :undoc-members: + :show-inheritance: + +fortls.parsers.internal.base module +----------------------------------- + +.. automodule:: fortls.parsers.internal.base + :members: + :undoc-members: + :show-inheritance: + +fortls.parsers.internal.block module +------------------------------------ + +.. automodule:: fortls.parsers.internal.block + :members: + :undoc-members: + :show-inheritance: + +fortls.parsers.internal.diagnostics module +------------------------------------------ + +.. automodule:: fortls.parsers.internal.diagnostics + :members: + :undoc-members: + :show-inheritance: + +fortls.parsers.internal.do module +--------------------------------- + +.. automodule:: fortls.parsers.internal.do + :members: + :undoc-members: + :show-inheritance: + +fortls.parsers.internal.enum module +----------------------------------- + +.. automodule:: fortls.parsers.internal.enum + :members: + :undoc-members: + :show-inheritance: + +fortls.parsers.internal.function module +--------------------------------------- + +.. automodule:: fortls.parsers.internal.function + :members: + :undoc-members: + :show-inheritance: + +fortls.parsers.internal.if\_block module +---------------------------------------- + +.. automodule:: fortls.parsers.internal.if_block + :members: + :undoc-members: + :show-inheritance: + +fortls.parsers.internal.imports module +-------------------------------------- + +.. automodule:: fortls.parsers.internal.imports + :members: + :undoc-members: + :show-inheritance: + +fortls.parsers.internal.include module +-------------------------------------- + +.. automodule:: fortls.parsers.internal.include + :members: + :undoc-members: + :show-inheritance: + +fortls.parsers.internal.interface module +---------------------------------------- + +.. automodule:: fortls.parsers.internal.interface + :members: + :undoc-members: + :show-inheritance: + +fortls.parsers.internal.intrinsics module +----------------------------------------- + +.. automodule:: fortls.parsers.internal.intrinsics + :members: + :undoc-members: + :show-inheritance: + +fortls.parsers.internal.method module +------------------------------------- + +.. automodule:: fortls.parsers.internal.method + :members: + :undoc-members: + :show-inheritance: + +fortls.parsers.internal.module module +------------------------------------- + +.. automodule:: fortls.parsers.internal.module + :members: + :undoc-members: + :show-inheritance: + +fortls.parsers.internal.parser module +------------------------------------- + +.. automodule:: fortls.parsers.internal.parser + :members: + :undoc-members: + :show-inheritance: + +fortls.parsers.internal.program module +-------------------------------------- + +.. automodule:: fortls.parsers.internal.program + :members: + :undoc-members: + :show-inheritance: + +fortls.parsers.internal.scope module +------------------------------------ + +.. automodule:: fortls.parsers.internal.scope + :members: + :undoc-members: + :show-inheritance: + +fortls.parsers.internal.select module +------------------------------------- + +.. automodule:: fortls.parsers.internal.select + :members: + :undoc-members: + :show-inheritance: + +fortls.parsers.internal.submodule module +---------------------------------------- + +.. automodule:: fortls.parsers.internal.submodule + :members: + :undoc-members: + :show-inheritance: + +fortls.parsers.internal.subroutine module +----------------------------------------- + +.. automodule:: fortls.parsers.internal.subroutine + :members: + :undoc-members: + :show-inheritance: + +fortls.parsers.internal.type module +----------------------------------- + +.. automodule:: fortls.parsers.internal.type + :members: + :undoc-members: + :show-inheritance: + +fortls.parsers.internal.use module +---------------------------------- + +.. automodule:: fortls.parsers.internal.use + :members: + :undoc-members: + :show-inheritance: + +fortls.parsers.internal.utilities module +---------------------------------------- + +.. automodule:: fortls.parsers.internal.utilities + :members: + :undoc-members: + :show-inheritance: + +fortls.parsers.internal.variable module +--------------------------------------- + +.. automodule:: fortls.parsers.internal.variable + :members: + :undoc-members: + :show-inheritance: + +fortls.parsers.internal.where module +------------------------------------ + +.. automodule:: fortls.parsers.internal.where + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: fortls.parsers.internal + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/fortls.parsers.rst b/docs/fortls.parsers.rst new file mode 100644 index 00000000..4cdca33f --- /dev/null +++ b/docs/fortls.parsers.rst @@ -0,0 +1,18 @@ +fortls.parsers package +====================== + +Subpackages +----------- + +.. toctree:: + :maxdepth: 4 + + fortls.parsers.internal + +Module contents +--------------- + +.. automodule:: fortls.parsers + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/fortls.rst b/docs/fortls.rst index 6a5964cc..713f668f 100644 --- a/docs/fortls.rst +++ b/docs/fortls.rst @@ -1,6 +1,14 @@ fortls package ============== +Subpackages +----------- + +.. toctree:: + :maxdepth: 4 + + fortls.parsers + Submodules ---------- @@ -12,6 +20,14 @@ fortls.constants module :undoc-members: :show-inheritance: +fortls.debug module +------------------- + +.. automodule:: fortls.debug + :members: + :undoc-members: + :show-inheritance: + fortls.ftypes module -------------------- @@ -36,14 +52,6 @@ fortls.interface module :undoc-members: :show-inheritance: -fortls.intrinsics module ------------------------- - -.. automodule:: fortls.intrinsics - :members: - :undoc-members: - :show-inheritance: - fortls.json\_templates module ----------------------------- @@ -68,26 +76,18 @@ fortls.langserver module :undoc-members: :show-inheritance: -fortls.objects module ---------------------- - -.. automodule:: fortls.objects - :members: - :undoc-members: - :show-inheritance: - -fortls.parse\_fortran module ----------------------------- +fortls.regex\_patterns module +----------------------------- -.. automodule:: fortls.parse_fortran +.. automodule:: fortls.regex_patterns :members: :undoc-members: :show-inheritance: -fortls.regex\_patterns module ------------------------------ +fortls.schema module +-------------------- -.. automodule:: fortls.regex_patterns +.. automodule:: fortls.schema :members: :undoc-members: :show-inheritance: