breath-apidoc do not generate the doxygen @examples

[MaximilienNaveau]

Short description

I would like breath-apidoc to generate .rst files containing the docs like doxygen generates upon using @example.

Detailed description

I have a small example of my usage of doxygen + breathe-apidoc + sphinx-apidoc + sphinx-build. On github. The output. In this small project I have a dummy C++ and Python code with some classes, templates, enums, etc. And some examples. And the idea is to build the API doc of Python and C++ together in one read-the-doc.

An example documentation generated by doxygen is here For now I did not find a way to exploit these @example in the sphinx documentation itself.

In here you have the full content of the index.xml file generated doxygen and processed by the full pipeline. You can clearly see at the end of the file the @example processed by breath properly.

We just need to extract the apidoc from the xml.

Hoping to participate

I may be willing to participate to the implementation of this new feature but I am not convinced I will have time...

[MaximilienNaveau]

I updated the comment above reviving the links and adding precision.