Merge pull request #391 from fortran-lang/docs/edits

docs/edits

Author: gnikit

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

.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

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)
 
 <!-- [<img alt="https://github.com/sponsors/gnikit" src="https://img.shields.io/static/v1?style=social&label=Sponsor&message=%E2%9D%A4&logo=GitHub&color&link=%3Curl%3E" height="30" />](https://github.com/sponsors/gnikit)
 [<img alt="https://paypal.me/inikit" src="https://img.shields.io/static/v1?style=social&label=Donate&message=%E2%9D%A4&logo=Paypal&color&link=%3Curl%3E" height="30" />](https://paypal.me/inikit) -->
@@ -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.
-
-<!--  Have a look at our roadmap (link) and consider contributing to our efforts (donations and contribution tasks link).  -->
+## 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.
+
+<!--  Have a look at our roadmap (link) and consider contributing to our efforts (donations and contribution tasks link).  -->
+
+### 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)
 
-<!-- ## Support
-
-If you want to support this project you can do it through
+## Support
 
-[![Alt](https://www.paypalobjects.com/webstatic/mktg/Logo/pp-logo-150px.png)](https://paypal.me/inikit)
-[!["Buy Me A Coffee"](https://www.buymeacoffee.com/assets/img/custom_images/orange_img.png)](https://www.buymeacoffee.com/gnikit) -->
+You can support Fortran-lang as a whole by donating at
+[Fortran-lang - NumFOCUS](https://numfocus.org/donate-for-fortran-lang).
 
 ## Bug reports
 

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