jothepro / doxygen-awesome-css

Custom CSS theme for doxygen html-documentation with lots of customization parameters.
https://jothepro.github.io/doxygen-awesome-css/
MIT License
981 stars 112 forks source link

Navigation is broken on mobile with Doxygen 1.9.2 #47

Closed nilsvu closed 2 years ago

nilsvu commented 2 years ago

Doxygen 1.9.2 creates a "hamburger menu" on mobile that conflicts with the doxygen-awesome CSS. Here's how it looks with Doxygen 1.9.2 in collapsed state:

Bildschirmfoto 2021-09-29 um 10 30 45

Here's how it looks in expanded state:

Bildschirmfoto 2021-09-29 um 10 33 43

I think this commit in Doxygen is responsible: https://github.com/doxygen/doxygen/commit/74b8e42b85cda8927e14511fba8b83f85b6ff2c9

gmarull commented 2 years ago

Experiencing the same issue on 1.9.2: https://teslabs.github.io/zephyr-doxygen-test/

leomccormack commented 2 years ago

It may not be related, but for me the dark/light toggle icon next to the search bar is missing with Doxygen 1.9.2. (https://leomccormack.github.io/Spatial_Audio_Framework/) (Rolling back to v1.9.1 fixes the issue.)

jothepro commented 2 years ago

Thanks for reporting these bugs!

The missing toggle button is a known issue (mentioned in #43) that was resolved in v1.6.0 by updating the documentation. I've updated the release notes to make this more noticeable:

https://github.com/jothepro/doxygen-awesome-css/releases/tag/v1.6.0

If you upgrade from doxygen 1.9.1 to 1.9.2 and you use the darkmode toggle from this repository, make sure to update your footer template! The call to initialize the toggle button now has to be wrapped in $(function() { ... })

dmadison commented 2 years ago

I can report these same issues. On mobile the search bar runs into the hamburger menu and the dark mode toggle runs off the screen. When testing in Chrome using the device toolbar, the dark mode toggle also disappears after resizing (and reappears on refresh).

I'm using doxygen 1.9.2 with the latest version of doxygen-awesome (1.6.0), including the $function() change mentioned above.

jothepro commented 2 years ago

Yesterday I discovered the problem with the button disappearing on resize as well... :( It seems like claiming that 1.6.0 is ready for doxygen 1.9.2 was a bit of an overstatement. I am experimenting on how to fix this, but it's difficult to find the correct spot in the DOM to mount the button... Ideas welcome and stay tuned!

jothepro commented 2 years ago

@nilsleiffischer pls close this issue if you can confirm that https://github.com/jothepro/doxygen-awesome-css/commit/644df904a84d8ed12cc3d7f825f40028f5ecae19 fixes the issue with the overlapping searchbar on mobile.

Disclaimer: the dark mode toggle is still broken, I've opened #52 for this bug.

jothepro commented 2 years ago

I think that all issues related to the search bar & the toggle button on mobile should be resolved in release 1.6.1. 🙏 Pls reopen if you are still experiencing problems.

nilsvu commented 2 years ago

I can confirm this issue is resolved, thanks @jothepro !

gmarull commented 2 years ago

Fixes the issue, thanks @jothepro ! ref. https://github.com/zephyrproject-rtos/zephyr/pull/39769