KSat/fsfw

History

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
..
fsfwconfig	Introducing documentation with Sphinx	2021-12-01 11:17:28 +01:00
README.md	restructure repository	2021-07-13 18:40:52 +02:00

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

fsfwconfig

Introducing documentation with Sphinx

2021-12-01 11:17:28 +01:00

README.md

restructure repository

2021-07-13 18:40:52 +02:00

README.md

How to setup configuration folder for FSFW

It is recommended to copy the content of the defaultcfg folder into a config folder which is in the same directory as the Flight Software Framework submodule. After that, the config.mk folder should be included by the primary Makefile with CURRENTPATH set correctly.