Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs/minor edits #378

Merged
merged 2 commits into from
Apr 26, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 14 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down Expand Up @@ -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/)
Expand Down
221 changes: 221 additions & 0 deletions docs/fortls.parsers.internal.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,221 @@
fortls.parsers.internal package
===============================

Submodules
----------

Check warning on line 5 in docs/fortls.parsers.internal.rst

View workflow job for this annotation

GitHub Actions / docs

duplicate label submodules, other instance in /github/workspace/docs/fortls.rst

Check warning on line 5 in docs/fortls.parsers.internal.rst

View workflow job for this annotation

GitHub Actions / docs

duplicate label submodules, other instance in /github/workspace/docs/fortls.rst

Check warning on line 5 in docs/fortls.parsers.internal.rst

View workflow job for this annotation

GitHub Actions / deploy-preview

duplicate label submodules, other instance in /github/workspace/docs/fortls.rst

Check warning on line 5 in docs/fortls.parsers.internal.rst

View workflow job for this annotation

GitHub Actions / deploy-preview

duplicate label submodules, other instance in /github/workspace/docs/fortls.rst

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
---------------

Check warning on line 216 in docs/fortls.parsers.internal.rst

View workflow job for this annotation

GitHub Actions / docs

duplicate label module contents, other instance in /github/workspace/docs/fortls.parsers.rst

Check warning on line 216 in docs/fortls.parsers.internal.rst

View workflow job for this annotation

GitHub Actions / docs

duplicate label module contents, other instance in /github/workspace/docs/fortls.parsers.rst

Check warning on line 216 in docs/fortls.parsers.internal.rst

View workflow job for this annotation

GitHub Actions / deploy-preview

duplicate label module contents, other instance in /github/workspace/docs/fortls.parsers.rst

Check warning on line 216 in docs/fortls.parsers.internal.rst

View workflow job for this annotation

GitHub Actions / deploy-preview

duplicate label module contents, other instance in /github/workspace/docs/fortls.parsers.rst

.. automodule:: fortls.parsers.internal
:members:
:undoc-members:
:show-inheritance:
18 changes: 18 additions & 0 deletions docs/fortls.parsers.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
fortls.parsers package
======================

Subpackages
-----------

Check warning on line 5 in docs/fortls.parsers.rst

View workflow job for this annotation

GitHub Actions / docs

duplicate label subpackages, other instance in /github/workspace/docs/fortls.rst

Check warning on line 5 in docs/fortls.parsers.rst

View workflow job for this annotation

GitHub Actions / docs

duplicate label subpackages, other instance in /github/workspace/docs/fortls.rst

Check warning on line 5 in docs/fortls.parsers.rst

View workflow job for this annotation

GitHub Actions / deploy-preview

duplicate label subpackages, other instance in /github/workspace/docs/fortls.rst

Check warning on line 5 in docs/fortls.parsers.rst

View workflow job for this annotation

GitHub Actions / deploy-preview

duplicate label subpackages, other instance in /github/workspace/docs/fortls.rst

.. toctree::
:maxdepth: 4

fortls.parsers.internal

Module contents
---------------

Check warning on line 13 in docs/fortls.parsers.rst

View workflow job for this annotation

GitHub Actions / docs

duplicate label module contents, other instance in /github/workspace/docs/fortls.rst

Check warning on line 13 in docs/fortls.parsers.rst

View workflow job for this annotation

GitHub Actions / docs

duplicate label module contents, other instance in /github/workspace/docs/fortls.rst

Check warning on line 13 in docs/fortls.parsers.rst

View workflow job for this annotation

GitHub Actions / deploy-preview

duplicate label module contents, other instance in /github/workspace/docs/fortls.rst

Check warning on line 13 in docs/fortls.parsers.rst

View workflow job for this annotation

GitHub Actions / deploy-preview

duplicate label module contents, other instance in /github/workspace/docs/fortls.rst

.. automodule:: fortls.parsers
:members:
:undoc-members:
:show-inheritance:
44 changes: 22 additions & 22 deletions docs/fortls.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,14 @@
fortls package
==============

Subpackages
-----------

.. toctree::
:maxdepth: 4

fortls.parsers

Submodules
----------

Expand All @@ -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
--------------------

Expand All @@ -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
-----------------------------

Expand All @@ -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:
Expand Down