Commit Graph

6 Commits

Author SHA1 Message Date
2dcf896cca
this sounds better 2022-02-10 14:04:23 +01:00
cdf2a90f90
fixed up cross-ref 2022-02-10 14:02:30 +01:00
b25555a533 started DHB docs 2022-02-10 13:53:59 +01:00
d0c7878da4
simplified test controller and added docs gitignore 2021-12-14 17:50:23 +01:00
df45f02c39
script fixes, odd behaviour 2021-12-03 14:55:00 +01:00
c2bf09d506 Introducing documentation with Sphinx
This PR introduces the generation of documentation based on
this excellent blog post: https://devblogs.microsoft.com/cppblog/clear-functional-c-documentation-with-sphinx-breathe-doxygen-cmake/

It combines the tools Sphinx, Doxygen and Breathe to generate good
looking HTML documentation conveniently which can be hosted easily.

The helper scripts were unified and there is now one helper.py script
which can be used to create, build and open both tests and documentation.
"./helper.py -h" can be used to get the different options.

This PR also contains some smaller fixes which were necessary for the docs
to build
2021-12-01 11:17:28 +01:00