Cantera / cantera

Chemical kinetics, thermodynamics, and transport tool suite
https://cantera.org
Other
582 stars 342 forks source link

Some doxygen links to cantera.org are broken #1592

Closed ischoegl closed 5 months ago

ischoegl commented 10 months ago

Problem description

The top menu "cantera.org" item on the updated doxygen website links back to the main documentation. From many pages things work as expected (e.g. from the main index page), with the intended redirect

https://cantera.org/

On other pages, the html code gets scrambled (e.g. deprecated list), i.e

https://cantera.org/documentation/dev/doxygen/html/https://cantera.org

Behavior

System information

Additional context

The XML entry generating the link is https://github.com/Cantera/cantera/blob/cde1e79567519646d1b6b9520c4a24d4f22f0f6c/doc/doxygen/DoxygenLayout.xml#L37

This follows the doxygen documentation

  <navindex>
    ...
    <tab type="user" url="http://www.google.com" title="Google"/>
    ...
  </navindex>

Other entries here have an additional intro="", which may or may not make a difference ... at the same time, this may be an upstream issue.

speth commented 10 months ago

Looks like an upstream issue (https://github.com/doxygen/doxygen/issues/9074) that was already fixed in Doxygen 1.9.4.

ischoegl commented 10 months ago

Thanks for tracking this down! I believe the runner builds with 1.9.1 - I guess ubuntu-latest (Ubuntu 22.04) uses an earlier version (1.9.1 was released Dec 24, 2022) ... I guess we can either use a newer pip version or wait until Ubuntu 24.04 makes it to GitHub? It's definitely a paper cut ...