Hi.

I'm trying to create some doc to help some new developers get familiar with a 
fairly large c++ codebase using Doxygen version 1.8.13.

Everything works great with the c++ things - I'm just stuck getting some of the 
user focused markup (readme.md) files included properly with their images.

In the code base, images are maintained in separate directories from the md 
files, and Doxygen doesn't seem to follow the relative paths (or at least 
doesn't the way I have things configured).

I have the image path defined to :

IMAGE_PATH             = /home/rgetz/github/sdrangel_upstream/doc/img/ 
/home/rgetz/github/sdrangel_upstream/sdrbase/resources/webapi/ 
/home/rgetz/github/sdrangel_upstream/sdrbase/resources/webapi/doc/swagger-ui/ 
/home/rgetz/github/sdrangel_upstream/sdrgui/resources/

Where are the actual images are (For example)
https://github.com/f4exb/sdrangel/tree/master/doc/img

This works in the top level Readme.md
https://github.com/f4exb/sdrangel/blob/master/Readme.md
![SDR Angel banner](doc/img/sdrangel_banner.png)

This gets pick up, and found, and that gets translated into html:
<img src="sdrangel_banner.png" alt="sdrangel_banner.png"/>

And the file gets copied over into the html_output directory:
file dev_docs/sdrangel_banner.png
dev_docs/sdrangel_banner.png: PNG image data, 904 x 314, 8-bit/color RGBA, 
non-interlaced

But leaf readme.md in directories down 
https://github.com/f4exb/sdrangel/blob/master/plugins/channelrx/chanalyzer/readme.md
in the md, uses:
![Channel Analyzer NG plugin GUI](../../../doc/img/ChAnalyzerNG_plugin.png)

So that it renders properly on the drive, and on github.

Via Doxygen, the html renders to:
<div class="image">
<img src="../../../doc/img/ChAnalyzerNG_plugin_settings.png" alt="Channel 
Analyzer NG plugin controls"/>
</div>

That that doesn't display properly (gets a broken image).

I have tried a few things, including setting the image_path to other 
directories, so that the relative path would work. For example:

IMAGE_PATH             = 
/home/rgetz/github/sdrangel_upstream/plugins/channelrx/chanalyzer/ 

Should work with:
plugins/channelrx/chanalyzer/../../../ doc/img/ChAnalyzerNG_plugin_settings.png

But that doesn't seem to work either.

Any pointers?

Thanks
-Robin



_______________________________________________
Doxygen-users mailing list
Doxygen-users@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/doxygen-users

Reply via email to