3.4. DocumentationΒΆ

These documentation pages are generated by Sphinx. The Breathe extension is used to extract Doxygen documentation from the code and create the API references. Also, the sphinx-version-warning extension is employed to show warnings for users viewing documentation for outdated or development versions of BDUS.

The dependencies on Sphinx, Breathe, and sphinx-version-warning are specified in docs/requirements.txt. Doxygen must also be installed to render the documentation.