search

vovkos / doxyrest

A compiler from Doxygen XML to reStructuredText -- hence, the name. It parses XML databases generated by Doxygen and produces reStructuredText for the Python documentation generator Sphinx.
MIT License
305 stars 23 forks source link

PlantUml #39

Open aimable-citron opened 3 years ago

aimable-citron commented 3 years ago

Hello,

I recently added plantuml diagrams in my documentation. They are well integrated in the html output from doxygen but in the xml, I only see the reference to the file and it does not seem to generate the image. I think it is not integrated in your tool. Is it planned to be integrated in the future?

regards,

vovkos commented 2 years ago

I believe @loebl already added support for PlantUml and other diagrams a while ago. Could you please share an MWE to demonstrate the issue? That would be great. Or the whole problematic project.

loebl commented 2 years ago

To chime in on that: That was in PR #27

The way it currently implemented is, it relies on graph code to be inline in the doxygen file. References to an external file are supported by the sphinx plugins, but requires changes to the lua module. Probably not much, but due to a lack of use case I haven't tested or implemented that.

Additionally you will need to make sure that your sphinx project loads the needed sphinx extensions.

vovkos commented 2 years ago

Oh, I see. Thanks! In any case, a real-life project to work with would help a lot.