fsfw/docs
Robin Mueller 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
..
api Introducing documentation with Sphinx 2021-12-01 11:17:28 +01:00
doxy Introducing documentation with Sphinx 2021-12-01 11:17:28 +01:00
images Introducing documentation with Sphinx 2021-12-01 11:17:28 +01:00
api.rst Introducing documentation with Sphinx 2021-12-01 11:17:28 +01:00
CMakeLists.txt Introducing documentation with Sphinx 2021-12-01 11:17:28 +01:00
conf.py Introducing documentation with Sphinx 2021-12-01 11:17:28 +01:00
config.rst Introducing documentation with Sphinx 2021-12-01 11:17:28 +01:00
controllers.rst Introducing documentation with Sphinx 2021-12-01 11:17:28 +01:00
core.rst Introducing documentation with Sphinx 2021-12-01 11:17:28 +01:00
devicehandlers.rst Introducing documentation with Sphinx 2021-12-01 11:17:28 +01:00
Doxyfile.in Introducing documentation with Sphinx 2021-12-01 11:17:28 +01:00
getting_started.rst Introducing documentation with Sphinx 2021-12-01 11:17:28 +01:00
highlevel.rst Introducing documentation with Sphinx 2021-12-01 11:17:28 +01:00
index.rst Introducing documentation with Sphinx 2021-12-01 11:17:28 +01:00
localpools.rst Introducing documentation with Sphinx 2021-12-01 11:17:28 +01:00
make.bat Introducing documentation with Sphinx 2021-12-01 11:17:28 +01:00
Makefile Introducing documentation with Sphinx 2021-12-01 11:17:28 +01:00
osal.rst Introducing documentation with Sphinx 2021-12-01 11:17:28 +01:00
pus.rst Introducing documentation with Sphinx 2021-12-01 11:17:28 +01:00
README-config.md Introducing documentation with Sphinx 2021-12-01 11:17:28 +01:00
README-controllers.md Introducing documentation with Sphinx 2021-12-01 11:17:28 +01:00
README-core.md Introducing documentation with Sphinx 2021-12-01 11:17:28 +01:00
README-devicehandlers.md Introducing documentation with Sphinx 2021-12-01 11:17:28 +01:00
README-highlevel.md Introducing documentation with Sphinx 2021-12-01 11:17:28 +01:00
README-localpools.md Introducing documentation with Sphinx 2021-12-01 11:17:28 +01:00
README-osal.md Introducing documentation with Sphinx 2021-12-01 11:17:28 +01:00
README-pus.md Introducing documentation with Sphinx 2021-12-01 11:17:28 +01:00