CI tools

[LecrisUT]

Some useful tooling that could be implemented. Let me know if you want some help with any of these:

• [ ] ReadTheDocs + sphinx: Documentation engine
• [ ] Github Action: Replace travis: (e.g. ctest, packaging, release) #37
• [ ] pre-commit: Enforce some style checks #37
• [ ] ctest: Replace manual test programs
• [ ] codecov: Report code coverage #37

[zerothi]

It would be great with the last 4 :)

In my preferential order: Github actions, codecov, pre-commit, ctest (I would probably like to do this one since I am still new to cmake, so getting my hands dirty is needed).

Thanks!!!

I am probably in favor of using ford for documentation. I want to support the fortran eco-system, and using that might be useful. :)

[LecrisUT]

For ctest, you can try my example at spglib for a quick reference.

Does ford produce html/md/rst documentation? If so, we can still link it to readthedocs. I would strongly recommend RTD because it handles the api versioning automatically. As for sphinx, one advantage is that we can use include to synchronize the README.md text with generated documentation.

[zerothi]

I know sphinx, and use it for other projects. ford is very similar to doxygen (can do md or rst AFAIK) and can still be used on RTD, so that isn't an issue.

ford, I am pretty sure, can do what you ask, but it has a focus on fortran :)

[LecrisUT]

Sure, I do not have a preference for one or another. If you can make a simple instruction about the documentation, I can help link it to RTD and/or sphinx.