diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index 94fddb5d..7c68730f 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -6,10 +6,13 @@ jobs: runs-on: ubuntu-latest steps: - uses: actions/checkout@v4 - - uses: sphinx-toolbox/sphinx-action@master + - uses: actions/setup-python@v5 with: - pre-build-command: "pip install .[docs]" - docs-folder: "docs/" + python-version: "3.11" + - name: Build docs + run: | + pip install -e .[dev,docs] + make -C docs html - name: Deploy uses: peaceiris/actions-gh-pages@v4 if: github.ref == 'refs/heads/master' diff --git a/.github/workflows/docs_preview.yml b/.github/workflows/docs_preview.yml index 1ce4c77b..c15e8248 100644 --- a/.github/workflows/docs_preview.yml +++ b/.github/workflows/docs_preview.yml @@ -23,12 +23,16 @@ jobs: runs-on: ubuntu-latest steps: - uses: actions/checkout@v4 - - uses: sphinx-toolbox/sphinx-action@master + - uses: actions/setup-python@v5 with: - pre-build-command: "pip install .[docs]" - docs-folder: "docs/" + python-version: "3.11" + - name: Build docs + run: | + pip install -e .[dev,docs] + make -C docs html - name: Deploy Preview uses: rossjrw/pr-preview-action@v1.4.7 with: source-dir: docs/_build/html preview-branch: gh-pages + custom-url: fortls.fortran-lang.org diff --git a/README.md b/README.md index a5af329d..75e4514a 100644 --- a/README.md +++ b/README.md @@ -13,6 +13,7 @@ ![Codecov](https://img.shields.io/codecov/c/github/fortran-lang/fortls?style=flat-square) [![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg?style=flat-square)](https://github.com/psf/black) ![GitHub Repo stars](https://img.shields.io/github/stars/fortran-lang/fortls?color=yellow&style=flat-square) +[![DOI](https://zenodo.org/badge/412392321.svg?style=flat-square)](https://zenodo.org/badge/latestdoi/412392321) @@ -65,22 +66,10 @@ and [Emacs](https://fortls.fortran-lang.org/editor_integration.html#emacs). - Signature help and hover does not handle elegantly overloaded functions i.e. interfaces -## 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. -It does however still have fundamental limitations, -namely its ability to understand all Fortran syntax and semantics that has been used throughout the 65+ years of the language. **The good news is that we have a plan to address this issue!** - -We are excited to announce that we are working on creating a new Fortran Language Server -based on the actively developed [LFortran](https://lfortran.org/) compiler 🎉. -The new Language Server will be able to understand all Fortran syntax, be faster, -and give more accurate autocompletion, hover and diagnostic information. That means we plan on investing any future funding on creating our new language server and ultimately creating a better user experience for everyone. - - +## Documentation -### What about `fortls`? - -Not to worry, `fortls` will continue to be here. We will keep `fortls` in maintenance mode with bug fixes and new features from volunteer contributors, but otherwise we will be focusing our efforts into making the new LFortran language server a reality. +The full documentation for `fortls` can be found at +[fortls.fortran-lang.org](https://fortls.fortran-lang.org/). ## Installation @@ -162,6 +151,23 @@ An example for a Configuration file is given below | `textDocument/didChange` | Document synchronisation upon changes to the document | | `textDocument/codeAction` | **Experimental** Generate code | +## 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. +It does however still have fundamental limitations, +namely its ability to understand all Fortran syntax and semantics that has been used throughout the 65+ years of the language. **The good news is that we have a plan to address this issue!** + +We are excited to announce that we are working on creating a new Fortran Language Server +based on the actively developed [LFortran](https://lfortran.org/) compiler 🎉. +The new Language Server will be able to understand all Fortran syntax, be faster, +and give more accurate autocompletion, hover and diagnostic information. That means we plan on investing any future funding on creating our new language server and ultimately creating a better user experience for everyone. + + + +### What about `fortls`? + +Not to worry, `fortls` will continue to be here. We will keep `fortls` in active maintenance mode with bug fixes and new features from volunteer contributors, but otherwise we will be focusing our efforts into making the new language server using LFortran's parser a reality. + ## `fortls` vs `fortran-language-server` This project was originally based on `fortran-language-server` LSP implementation, but the two projects have since diverged. @@ -181,12 +187,10 @@ change in the future. This project would not have been possible without the original work of [@hansec](https://github.com/hansec/) in [`fortran-language-server`](https://github.com/hansec/fortran-language-server) - +You can support Fortran-lang as a whole by donating at +[Fortran-lang - NumFOCUS](https://numfocus.org/donate-for-fortran-lang). ## Bug reports diff --git a/docs/contributing.rst b/docs/contributing.rst index d16c56df..91e4a254 100644 --- a/docs/contributing.rst +++ b/docs/contributing.rst @@ -7,16 +7,11 @@ There are a few ways you can support the ``fortls`` project. Financial Support ------------------ -.. You can support us financially by becoming a **GitHub Sponsor** or by -.. making a **PayPal Donation**. +You can fiscally support Fortran-lang by donating to the project, see +`Fortran-lang - NumFOCUS`_. -.. note:: - We are in the process of restructuring our Sponsorship structure. - In the meantime, please get in contact with ``gnikit`` via email at - ``gnikit [@] duck [.] com`` or any other `Administrator of Fortran-lang`_ - for instructions to financially back the project. +.. _Fortran-lang - NumFOCUS: https://numfocus.org/donate-for-fortran-lang -.. _Administrator of Fortran-lang: https://github.com/orgs/fortran-lang/teams/admins/members .. .. grid:: 2 .. :gutter: 0