Documenting an esp32 project with Doxygen/Breathe/Sphinx

peterdroberts
Posts: 2
Joined: Wed May 26, 2021 3:11 pm

Documenting an esp32 project with Doxygen/Breathe/Sphinx

Postby peterdroberts » Mon Jun 07, 2021 9:07 am

I've done some basic searching for this and couldn't find an existing answer.

I've joined a team with existing esp32 code and would like to implement automated documentation for it. Doxygen-style comments are in the code already, but there is not a doxygen output set up.

The project uses the esp-idf style cmake commands with idf_component_register etc.

Currently I can only find documentation on how to document the esp-idf repository itself.

It seems like I could adapt the esp-idf documentation tools for the project I'm working on, but I can't find any documentation on this or examples of anyone who's done it. Am I missing something obvious here and can someone give me links to examples of an implementation?

ESP-Marius
Posts: 66
Joined: Wed Oct 23, 2019 1:49 am

Re: Documenting an esp32 project with Doxygen/Breathe/Sphinx

Postby ESP-Marius » Tue Jun 08, 2021 12:11 am

We are actually working on decoupling the documentation build system we have from IDF in order to make it easier for other Espressif projects to use it. Seems like this something that could benefit you as well!

For your use-case it seems like you might not need any of functionality we added on-top of the standard doxygen/breathe/sphinx/readthedocs setup though.

Some help getting started can be found here:

peterdroberts
Posts: 2
Joined: Wed May 26, 2021 3:11 pm

Re: Documenting an esp32 project with Doxygen/Breathe/Sphinx

Postby peterdroberts » Thu Jun 10, 2021 12:23 pm

Thank you!

Who is online

Users browsing this forum: No registered users and 39 guests