Add documentation

[RMeli]

• Close Add documentation #7
• Add GitHub Action to automatically deploy documentation on the gh-pages branch

Documentation Preview

The documentation is currently incomplete: only one function per algorithm is documented, plus the helper functions. It will be completed once the phrasing is agreed upon.

[rasolca]

Preliminary questions:
Is the doc already available somewhere?
Any plan to keep the documentation of released versions?

[RMeli]

Is the doc already available somewhere?

There is a preview from my fork: https://rmeli.github.io/DLA-Future-Fortran

Any plan to keep the documentation of released versions?

Not really... I'm open to suggestions.

[msimberg]

I like the looks of it.

[RMeli]

I created an orphan docs-ghpages branch, made it a protected branch, and set it as the deployment branch for GitHub Pages.

Documentation for my fork is now available at https://rmeli.github.io/DLA-Future-Fortran/main/

[RMeli]

I incorporated all comments (also from offline) and added wording for the _factorized generalised eigensolver. Please have one more look at the current look and wording: https://rmeli.github.io/DLA-Future-Fortran/main/index.html

If this is OK, I'll add the same documentation to all functions.

[RMeli]

Needs to be removed before merging.

[RMeli]

Fix before merging.

[rasolca]

Looks good