Commit Graph

4 Commits

Author SHA1 Message Date
muellerr 8dea13742f update rst file 2022-09-15 13:57:39 +02:00
mohr d2ac3603a5 some more occurences 2022-08-16 12:29:53 +02:00
muellerr cdf2a90f90 fixed up cross-ref 2022-02-10 14:02:30 +01:00
muellerr 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