espressif / idf-extra-components

Additional components for ESP-IDF, maintained by Espressif
147 stars 89 forks source link

Add API reference for components (IEC-57) #248

Open igrr opened 11 months ago

igrr commented 11 months ago

Is your feature request related to a problem?

It is difficult to discover/learn the API of components which aren't ports of well-known libraries.

Describe the solution you'd like.

Component Registry now supports displaying the contents of API.md file, if it is provided in the component directory. We also have a pre-commit hook to generate API.md from Doxygen-generated XML files.

Describe alternatives you've considered.

Additional context.

Example repo where API.md is set up: https://github.com/igrr/pa1010d

igrr commented 11 months ago

At the moment, doxybook only supports a single Doxyfile as input and a single API.md as output. We'll have to change this to make it usable for multiple components in the same repo.