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
306 stars 23 forks source link

Duplicate Images #51

Open keithmballard opened 1 year ago

keithmballard commented 1 year ago

Hello,

I am relatively new to doxyrest, but I have been very impressed.

One issue I have observed, when parsing Markdown, Doxygen will create multiple image tags for each type of output: image

It appears that Doxyrest does not detect that the same image is repeated for multiple "ImageKind" types: image

Am I misunderstanding something, or does a bit of logic need to be added to parsing to avoid the duplicate images? Any input is welcome.

Thanks, Keith Ballard

keithmballard commented 1 year ago

I am happy to modify to the code to fix this issue, but I would need some guidance.

My current thought is that I only want the HTML image tags, so other types can be ignored with these two small modifications: image

image

A few questions:

  1. Is my assumption about image tags applicable to all users?
  2. Or should there be a configuration option to select a particular tag?
  3. More broadly, should be apply to more than just images?