search

ECP-WarpX / WarpX

WarpX is an advanced electromagnetic & electrostatic Particle-In-Cell code.
https://ecp-warpx.github.io
Other
290 stars 184 forks source link

Doxygen links to AMReX Doxygen pointing to wrong place #2544

Open etpalmer63 opened 2 years ago

etpalmer63 commented 2 years ago

This issue arises when I attempt to click on the link from the Doxygen page for LaserProfilers.H, https://warpx.readthedocs.io/en/latest/_static/doxyhtml/_laser_profiles_8_h.html.

On that page, if you click on the AMReX_Gpu.H link, you will be taken to https://amrex-codes.github.io/amrex/doxygen/AMReX__Gpu_8H.html.html. This results in a 404 error. Instead, it should link to https://amrex-codes.github.io/amrex/doxygen/AMReX__Gpu_8H.html with one less .html at the end. Perhaps its an issue with the readthedocs.io integration.

ax3l commented 2 years ago

Thanks for the report! Curious, the class links work, e.g., to AmrCore: https://warpx.readthedocs.io/en/latest/_static/doxyhtml/class_warp_x.html

ax3l commented 2 years ago

Bit puzzled how to solve this though, this is all we set to cross link the pages: https://github.com/ECP-WarpX/WarpX/blob/b0c2c4286fa15f93a780625b51beb03362dc26c0/Docs/Doxyfile#L2107

Seems only to be a problem with links to AMReX source files - classes and other objects work :thinking:

Maybe that's a Doxygen bug that we need to report upstream?

etpalmer63 commented 2 years ago

It could be because some AMReX files are not properly/fully documented. -- I'll look into it.

Seems like its not a problem with the AMReX files, since in this case the link to AMReX_MultiFab.H does not work, and in this case the same link does.

I also tried the latest release version of Doxygen, 1.9.2, and the issue persists. Off to file a bug report with Doxygen now. :smile:

etpalmer63 commented 2 years ago

Reported to Doxygen: https://github.com/doxygen/doxygen/issues/8889

etpalmer63 commented 2 years ago

A fix has already been pushed to address the issue in the AMReX Doxygen.

I mentioned the issue in WarpX to the Doxygen maintainer, but I couldn't recreate the extra ".html" bug. It turns out that when I build locally, the link works. For both versions 1.9.2 and 1.8.17. It looks like you're running ver. 1.8.13, maybe you could try 1.8.17 and see if that fixes the problem?

ax3l commented 2 years ago

Excellent, will update to see if that fixes it :rocket: Thanks a lot for doing the upstream report & coordination, appreciate it!

ax3l commented 2 years ago

Awesome, I think Doxygen 1.9.3 should contain the fixes :tada: https://github.com/doxygen/doxygen/issues/8889#issuecomment-1003344445