Consider ford for Fortran documentation

[christopheredsall]

We could consider using FORD for automatically documenting the Fortran code (similar to Doxygen for C++ or sphinx for python)

• Repo: https://github.com/Fortran-FOSS-Programmers/ford
• Docs: https://forddocs.readthedocs.io/en/latest/

[jatkinson1000]

Definitely, and I will try and include this in my refactoring of #33
Given the challenges with interfacing with CAM which has different representations of physical quantities we may also want to use CamFORT to try and impose some checks that interfaces are working correctly.

Maybe a separate issue and PR?

[dorchard]

Definitely, and I will try and include this in my refactoring of #33 Given the challenges with interfacing with CAM which has different representations of physical quantities we may also want to use CamFORT to try and impose some checks that interfaces are working correctly.

Good idea- I can help with that!

[jatkinson1000]

This is the remaining issue left to reach Milestone 1 (pending PR reviews).
I have started adding some FORD.
Do we want to shelve this or commit to fully implementing it?

[mondus]

Comments are mostly done (in PR #33) but some infrastructure is needed to close this issue. E.g. CI to generate and host the docs somewhere. This could be moved to Milestone 2.