emenel/doomemacs
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

docs(fortran,graphql): update READMEs to new format

Browse source 
Also preforms minor spelling, grammar, and formatting corrections.
This commit is contained in:
Henrik Lissner 2022-08-04 01:12:52 +02:00
parent 304774cf39
commit 1b59b9a83a
No known key found for this signature in database
GPG key ID: B60957CA074D39A3
2 changed files with 124 additions and 110 deletions
Download patch file Download diff file Expand all files Collapse all files

133
modules/lang/fortran/README.org
View file

@ -1,102 +1,95 @@
#+TITLE: lang/fortran # -*- mode: doom-docs-org -*-
#+DATE: October 22, 2021 #+title: :lang fortran
#+SINCE: v3.0.0 (#5676) #+subtitle: In FORTRAN, GOD is REAL (unless declared INTEGER)
#+STARTUP: inlineimages nofold #+date: October 22, 2021
#+since: 22.04.0 (#5676)
* Table of Contents :TOC_3:noexport:
- [[#description][Description]]
- [[#maintainers][Maintainers]]
- [[#module-flags][Module Flags]]
- [[#plugins][Plugins]]
- [[#prerequisites][Prerequisites]]
- [[#general][General]]
- [[#arch-linux][Arch Linux]]
- [[#installing-intel-fortran][Installing Intel Fortran]]
- [[#features][Features]]
- [[#configuration][Configuration]]
- [[#troubleshooting][Troubleshooting]]
* Description
* Description :unfold:
This module enables a complete, modern development environment for the [[https://fortran-lang.org/][Fortran]] This module enables a complete, modern development environment for the [[https://fortran-lang.org/][Fortran]]
language. Initially released in 1956 (a year before Lisp 1.0), Fortran is the language. Initially released in 1956 (a year before Lisp 1.0), Fortran is the
original high-performance computation language and is still widely used in original high-performance computation language and is still widely used in
science and academia. Popular versions of the language include Fortran 77 and science and academia. Popular versions of the language include Fortran 77 and
Fortran 90, with further extensions in the 1995 and 2008 varieties. Today, Fortran 90, with further extensions in the 1995 and 2008 varieties. Today,
Fortran has joined the modern age with its own [[https://github.com/fortran-lang/fpm][package manager]], [[https://fortran-lang.org/packages/][package Fortran has joined the modern age with its own [[https://github.com/fortran-lang/fpm][package manager]], [[https://fortran-lang.org/packages/][package registry]]
registry]], and [[https://fortran-lang.discourse.group/][Discourse community]]. and [[https://fortran-lang.discourse.group/][Discourse community]].
In particular, this module features: In particular, this module features:
- Support for all major Fortran varieties.
+ Support for all major Fortran varieties. - Auto-formatting via =fprettier=.
+ Auto-formatting via =fprettier=. - Integration with the =fpm= package manager.
+ Integration with the =fpm= package manager. - LSP support via [[https://github.com/gnikit/fortls][fortls]].
+ LSP support via [[https://github.com/gnikit/fortls][fortls]]. - Optional Intel Fortran support via the [[doom-module:][+intel]] flag.
+ Optional Intel Fortran support via the =+intel= flag.
#+begin_quote #+begin_quote
After a career of writing Fortran on Mainframes and Windows machines, my 💬 After a career of writing Fortran on Mainframes and Windows machines, my
now-retired Dad is switching to Linux. Imagine my surprise when I learned that now-retired Dad is switching to Linux. Imagine my surprise when I learned
off-the-shelf setups for Fortran on Linux basically don't exist! Well, until that off-the-shelf setups for Fortran on Linux basically don't exist! Well,
now... Cheers Dad, hope this helps. until now... Cheers Dad, hope this helps. --[[doom-user:][fosskers]]
#+end_quote #+end_quote
** Maintainers ** Maintainers
+ [[https://github.com/fosskers][@fosskers]] (Author) - [[doom-user:][@fosskers]]
** Module Flags [[doom-contrib-maintainer:][Become a maintainer?]]
+ =+lsp= Activate =fortls= for Fortran projects.
+ =+intel= Use the =ifort= compiler by default.
** Plugins ** Module flags
- +lsp ::
Enable LSP support for ~fortran-mode~. Requires [[doom-module:][:tools lsp]] and a langserver
(fortls).
- +intel ::
Use the =ifort= compiler by default.
* Prerequisites ** Packages
/This module doesn't install any packages./
** Hacks
/No hacks documented for this module./
** TODO Changelog
# This section will be machine generated. Don't edit it by hand.
/This module does not have a changelog yet./
* Installation
[[id:01cffea4-3329-45e2-a892-95a384ab2338][Enable this module in your ~doom!~ block.]]
** General ** General
For minimum functionality, this module requires =gfortran=. For most project For minimum functionality, this module requires =gfortran=. For most project
management tasks you will also need [[https://github.com/fortran-lang/fpm][fpm]], the Fortran Package Manager. management tasks you will also need [[https://github.com/fortran-lang/fpm][fpm]], the Fortran Package Manager.
*** Arch Linux *** Arch Linux
=gfortran= is available from the official repositories: =gfortran= is available from the official repositories:
#+begin_src bash
#+begin_example $ sudo pacman -S gcc-fortran
sudo pacman -S gcc-fortran #+end_src bash
#+end_example
Whereas =fpm= and =fortls= are available from the AUR and thus must be installed Whereas =fpm= and =fortls= are available from the AUR and thus must be installed
with an AUR-compatible tool like [[https://github.com/fosskers/aura][Aura]]: with an AUR-compatible tool like [[https://github.com/fosskers/aura][Aura]]:
#+begin_src bash
#+begin_example $ sudo aura -A fortran-fpm fortls
sudo aura -A fortran-fpm fortls #+end_src bash
#+end_example
** Installing Intel Fortran ** Installing Intel Fortran
Activating the [[doom-module:][+intel]] flag won't automatically install Intel Fortan for you.
Activating the =+intel= flag won't automatically install Intel Fortan for you.
Here's how to do it on *nix systems. Here's how to do it on *nix systems.
You can of course install the entire High-performance Computing kit from Intel, You can of course install the entire High-performance Computing kit from Intel,
which includes Fortran, but the installation footprint is quite large. Instead, which includes Fortran, but the installation footprint is quite large. Instead,
you're able to install just Fortran and its core facilities on their own as a you're able to install just Fortran and its core facilities on their own as a
[[https://www.intel.com/content/www/us/en/developer/articles/tool/oneapi-standalone-components.html#fortran][standalone component]]. Download this script, and make it executable via: [[https://www.intel.com/content/www/us/en/developer/articles/tool/oneapi-standalone-components.html#fortran][standalone component]]. Download this script, and make it executable via:
#+begin_src bash
#+begin_example $ chmod +x l_fortran-compiler_p_2022.0.3.83_offline.sh
chmod +x l_fortran-compiler_p_2022.0.3.83_offline.sh #+end_src bash
#+end_example
The filepath will of course change with time, so alter the above command The filepath will of course change with time, so alter the above command
accordingly. Now run the script _as a normal user_ (non-sudo) and follow the accordingly. Now run the script _as a normal user_ (non-sudo) and follow the
instructions of the installer. This will install =ifort=, etc., in a local instructions of the installer. This will install =ifort=, etc., in a local
filepath of your choosing. filepath of your choosing.
To actually use =ifort= and have it link to its libraries properly, we must run a To actually use =ifort= and have it link to its libraries properly, we must run
script provided by Intel to set certain environment variables: a script provided by Intel to set certain environment variables:
#+begin_src bash
#+begin_example $ . ~/intel/oneapi/setvars.sh
. ~/intel/oneapi/setvars.sh #+end_src
#+end_example
(Modify according to where you installed Intel Fortran.) Now =ifort= should be (Modify according to where you installed Intel Fortran.) Now =ifort= should be
runnable in your terminal as you'd expect. _To persist this, add that line to runnable in your terminal as you'd expect. _To persist this, add that line to
@ -105,11 +98,23 @@ your Bash Profile, etc., and log out and in again._ Now Doom will be able to use
Good luck and happy computing! Good luck and happy computing!
* Features * TODO Usage
# An in-depth list of features, how to use them, and their dependencies. #+begin_quote
🔨 This module has no usage documentation yet. [[doom-contrib-module:][Write some?]]
#+end_quote
* Configuration * TODO Configuration
# How to configure this module, including common problems and how to address them. #+begin_quote
🔨 This module has no configuration documentation yet. [[doom-contrib-module:][Write some?]]
#+end_quote
* Troubleshooting * Troubleshooting
# Common issues and their solution, or places to look for help. /There are no known problems with this module./ [[doom-report:][Report one?]]
* Frequently asked questions
/This module has no FAQs yet./ [[doom-suggest-faq:][Ask one?]]
* TODO Appendix
#+begin_quote
🔨 This module has no appendix yet. [[doom-contrib-module:][Write one?]]
#+end_quote

101
modules/lang/graphql/README.org
View file

@ -1,54 +1,53 @@
#+TITLE: lang/graphql # -*- mode: doom-docs-org -*-
#+DATE: March 31, 2022 #+title: :lang graphql
#+SINCE: v2.0 #+subtitle: Give queries a REST
#+STARTUP: inlineimages nofold #+created: March 31, 2022
#+since: 22.04.0 (#6226)
* Table of Contents :TOC_3:noexport: * Description :unfold:
- [[#description][Description]]
- [[#maintainers][Maintainers]]
- [[#module-flags][Module Flags]]
- [[#plugins][Plugins]]
- [[#hacks][Hacks]]
- [[#prerequisites][Prerequisites]]
- [[#features][Features]]
- [[#sending-queries][Sending queries]]
- [[#viewing-docs][Viewing docs]]
- [[#configuration][Configuration]]
- [[#troubleshooting][Troubleshooting]]
* Description
This module adds [[https://www.graphql.org][GraphQL]] support to Doom Emacs. This module adds [[https://www.graphql.org][GraphQL]] support to Doom Emacs.
+ Code completion It includes:
+ LSP support (=+lsp=) - Code completion
+ Diagnostics (GraphQL syntax linting/validations) (spec-compliant) - LSP support ([[doom-module:][+lsp]])
+ Autocomplete suggestions (spec-compliant) - Diagnostics (GraphQL syntax linting/validations) (spec-compliant)
+ Hyperlink to fragment definitions and named types (type, input, enum) definitions (spec-compliant) - Autocomplete suggestions (spec-compliant)
+ Outline view support for queries and SDL - Hyperlink to fragment definitions and named types (type, input, enum) definitions (spec-compliant)
+ Symbols support across the workspace - Outline view support for queries and SDL
+ Local schema viewer - Symbols support across the workspace
+ Org-babel exporter (requires =:lang org=) - Local schema viewer
- Org-babel exporter (requires [[doom-module:][:lang org]])
** Maintainers ** Maintainers
+ [[https://github.com/elken][@elken]] (Author) - [[doom-user:][@elken]]
** Module Flags [[doom-contrib-maintainer:][Become a maintainer?]]
+ =+lsp= Enable LSP support through [[https://github.com/graphql/graphiql/tree/main/packages/graphql-language-service-cli#readme][graphql-language-service-cli]] (also requires =:tools lsp=)
** Plugins ** Module flags
+ [[https://github.com/davazp/graphql-mode][graphql-mode]] - +lsp ::
+ [[https://github.com/ifitzpatrick/graphql-doc.el][graphql-doc]] Enable LSP support for ~graphql-mode~. Requires [[doom-module:][:tools lsp]] and a langserver
+ [[https://github.com/timoweave/company-graphql][company-graphql]] (when =+lsp= is disabled) ([[https://github.com/graphql/graphiql/tree/main/packages/graphql-language-service-cli#readme][graphql-language-service-cli]]).
** Packages
- [[doom-package:][company-graphql]] unless [[doom-module:][+lsp]]
- [[doom-package:][graphql-mode]]
- [[doom-package:][graphql-doc]]
** Hacks ** Hacks
Added a convenience function =+graphql-doc-open-config= to open schema docs from a - Added a convenience function [[fn:][+graphql-doc-open-config]] to open schema docs from
[[https://github.com/jimkyndemeyer/graphql-config-examples][=.graphqlconfig=]] file. a [[https://github.com/jimkyndemeyer/graphql-config-examples][.graphqlconfig]] file.
* Prerequisites ** TODO Changelog
There are no prerequisites for using this module. LSP server should be # This section will be machine generated. Don't edit it by hand.
downloaded upon opening a graphql buffer. /This module does not have a changelog yet./
* Features * Installation
[[id:01cffea4-3329-45e2-a892-95a384ab2338][Enable this module in your ~doom!~ block.]]
This module has no direct requirements, but the +lsp flag requires a [[https://emacs-lsp.github.io/lsp-mode/page/lsp-graphql/][supported
LSP server]].
* Usage
** Sending queries ** Sending queries
When visiting a graphql buffer, you have access to the ability to send the When visiting a graphql buffer, you have access to the ability to send the
current query with =C-c C-c= which will prompt you for an optional variables file, current query with =C-c C-c= which will prompt you for an optional variables file,
@ -100,16 +99,26 @@ When using the doc viewer, there are a few bindings for navigating around.
| =RET= | - | Follow the next label under =point= | | =RET= | - | Follow the next label under =point= |
* Configuration * Configuration
Most of the "magic" in the module relies on a properly configured Most of the "magic" in the module relies on a properly configured [[https://github.com/jimkyndemeyer/graphql-config-examples][.graphqlconfig]]
[[https://github.com/jimkyndemeyer/graphql-config-examples][=.graphqlconfig=]] file, so follow the examples linked to create an appropriate file, so follow the examples linked to create an appropriate setup.
setup.
LSP configuration is handled through [[https://github.com/graphql/graphiql/tree/main/packages/graphql-language-service-cli#graphql-configuration-file-graphqlrcyml][GraphQL Config]] to handle custom directives/documents/validation etc. LSP configuration is handled through [[https://github.com/graphql/graphiql/tree/main/packages/graphql-language-service-cli#graphql-configuration-file-graphqlrcyml][GraphQL Config]] to handle custom
directives/documents/validation etc.
These files will also be useful to other editors, so it would be worth trying to These files will also be useful to other editors, so it would be worth checking
get them into version control. them into version control.
* Troubleshooting * Troubleshooting
[[doom-report:][Report an issue?]]
- [[https://github.com/ifitzpatrick/graphql-doc.el/issues][Issues with the doc viewer]] - [[https://github.com/ifitzpatrick/graphql-doc.el/issues][Issues with the doc viewer]]
- [[https://github.com/davazp/graphql-mode/issues][Issues with graphql-mode]] - [[https://github.com/davazp/graphql-mode/issues][Issues with graphql-mode]]
- [[https://github.com/emacs-lsp/lsp-mode/issues][Issues with LSP]] ([[https://github.com/graphql/graphiql/issues][Upstream LSP issues]]) - [[https://github.com/emacs-lsp/lsp-mode/issues][Issues with LSP]] ([[https://github.com/graphql/graphiql/issues][Upstream LSP issues]])
* Frequently asked questions
/This module has no FAQs yet./ [[doom-suggest-faq:][Ask one?]]
* TODO Appendix
#+begin_quote
🔨 This module has no appendix yet. [[doom-contrib-module:][Write one?]]
#+end_quote