Open kblaschke opened 1 year ago
Looking around at the best way to bridge doxygen to sphinx, I'm seeing a lot of references to breathe, which is available from pypi and is also included in at least Ubuntu package repositories, whereas doxyrest does not appear to be. Is doxyrest a requirement or just one option for converting Doxygen output to something sphinx can import?
Currently, libprojectM is documented in many different places: some Markdown files in the source code, the GitHub Wiki page and missing a generated Doxygen API documentation.
To keep the docs in one place and have them matching the current state of the code, we should add a
docs
dir in the library repo, with ReStructuredText (RST) files documenting all required parts:Using Sphinx to generate and deploy the docs via GitHub Actions will keep the docs up to date all the time, and users can find it in a single place.
What needs to be done?
docs
subdirectory of the projectm repository.