SOAR-UWU / UWU-Blobfish

General repo for Underwater Unit 2024
1 stars 0 forks source link

Set up documentation generator #4

Open CyonixC opened 8 months ago

CyonixC commented 8 months ago

(Lack of) documentation was a serious issue in previous iterations. Thus it would be good to set up a documentation generator, such as Doxygen or Sphinx. Include use instructions as well in the README file.

CyonixC commented 5 months ago

Since there are both C++ files and Python files, a combination of Doxygen for C++ documentation generation, Sphinx for Python code generation and documentation formatting, and Breathe for adapting Doxygen output to Sphinx will be used.

A very brief and kinda sketchy quickstart can be found in this Medium article.