DotBots / DotBot-firmware

Firmware applications used to control DotBots and SailBots
https://dotbot-firmware.readthedocs.io/en/latest
BSD 3-Clause "New" or "Revised" License
5 stars 8 forks source link

doc: use sphinx + breathe + doxygen to generate the documentation #238

Closed aabadie closed 11 months ago

aabadie commented 11 months ago

This is a follow-up of #237 which uses Sphinx with the breather extension to generate the documentation. The sphinx doc uses the pydata-sphinx-theme because it is nice. There's a lot of room for improvements but the result is already much better than with Doxygen alone.

In terms of CI, the make doc command is configured to build doxygen first and then run sphinx-build in "warning as error" and "nitpicks" mode.