espressif/esp-docs

[questions] Multi-target build

chegewara opened this issue · 1 comments

Hi team,
i have to say it is really cool tool. Even if there is a bit more work to do it looks much nicer than doxygen generated documentation.

I have the need to build 1 firmware for few hardware revisions, and if its fairly easy to build docs for esp32 chips, i am wondering if there is an option to build for hardware revision instead, since all versions are based on the same chip. Command line only accepts esp32-like targets, also changing targets in versions.js does not help.

Another question is: is there option to block or to change version build on top of non-tag code, when esp-docs is generating links like this

_build/en/v4.0.4-5-g9d4e9af/index.html

I am asking this because i would like for example to add esp-docs to already existing tagged versions. Its not a big deal, because firmware is still in development phase, but would be nice to have.

How to avoid this kind of build error:

en/esp32: If the function has no return type:
en/esp32:   Error in declarator or parameters-and-qualifiers
en/esp32:   Invalid C++ declaration: Expected identifier in nested name, got keyword: const [error at 5]
en/esp32:     const __attribute__ ((section(".rodata_custom_desc"))) custom_app_desc_t custom_app_desc

Last question i have for now is, why esp-docs or sphinx does not accept upper case header files, is it know issue?

Thanks

Hi,

i found the solution to __attribute__ here:
https://github.com/espressif/esp-idf/blob/master/docs/doxygen/Doxyfile#L279-L287

Also i solved problem with tagging and paths. I have to build with clean tag announced version.

Thanks