Documentation

[EnricoDeg]

Should the documentation be in the Github wiki section or internal to the repo folder (doc folder) or?

[EnricoDeg]

Initial idea is here:

https://github.com/EnricoDeg/TKE/tree/wip_doc

and it is based on this article:

https://medium.com/practical-coding/c-documentation-with-doxygen-cmake-sphinx-breathe-for-those-of-use-who-are-totally-lost-7d555386fe13

To create the documentation, run the following command from the doc folder:

sphinx-build -M html source _build

The dependencies can be all installed with:

pip install sphinx

spack install doxygen

pip install sphinx-sitemap

pip install breathe

Part 3 of the article describe "Getting GitHub actions to automatically build and host our documentation for us", but I didn't try it yet.

[EnricoDeg]

Reference for code documentation: https://www.doxygen.nl/manual/docblocks.html

[EnricoDeg]

Breathe does not support fortran code so we can not generate documentation in readthedocs about the fortran interface