Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

doc/doxygen: fix sidenav handling [backport 2024.04] #20632

Merged

Conversation

maribu
Copy link
Member

@maribu maribu commented Apr 27, 2024

Backport of #20631

Contribution description

In https://github.com/RIOT-OS/RIOT/pull/20511/files a quick fix was added to allow resizing the sidenav. But this broke hiding the sidenav on mobile screen widths. This fixes the issue and also increase the default sidenav width a tad.

Testing procedure

Check the generated doc preview also from a mobile device. It should no longer display the sidenav on small form factors (e.g. phones, or browsers resized to a narrow view) but still allow resizing the sidenav with the mouse on larger form factors.

Issues/PRs references

Fixes regression from https://github.com/RIOT-OS/RIOT/pull/20511/files

In https://github.com/RIOT-OS/RIOT/pull/20511/files a quick fix was
added to allow resizing the sidenav. But this broke hiding the sidenav
on mobile screen widths. This fixes the issue and also increase the
default sidenav width a tad.

(cherry picked from commit 166d3aa)
@maribu maribu requested review from aabadie and jia200x as code owners April 27, 2024 16:35
@maribu maribu added Area: doc Area: Documentation CI: ready for build If set, CI server will compile all applications for all available boards for the labeled PR Impact: minor The PR is small in size and might only require a quick look of a knowledgeable reviewer Process: release backport Integration Process: The PR is a release backport of a change previously provided to master Type: bug The issue reports a bug / The PR fixes a bug (including spelling errors) labels Apr 27, 2024
@maribu maribu requested a review from dylad April 27, 2024 16:35
@riot-ci
Copy link

riot-ci commented Apr 27, 2024

Murdock results

✔️ PASSED

936147e doc/doxygen: fix sidenav handling

Success Failures Total Runtime
1 0 1 01m:08s

Artifacts

Copy link
Member

@dylad dylad left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It still looks good on my side.

@dylad dylad added this pull request to the merge queue Apr 27, 2024
Merged via the queue into RIOT-OS:2024.04-branch with commit 0983fe4 Apr 27, 2024
31 checks passed
@maribu maribu deleted the backport/2024.04/doc/doxygen/fix-sidenav branch April 27, 2024 17:42
@maribu
Copy link
Member Author

maribu commented Apr 27, 2024

Thx :)

@MrKevinWeiss MrKevinWeiss added this to the Release 2024.04 milestone Apr 30, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Area: doc Area: Documentation CI: ready for build If set, CI server will compile all applications for all available boards for the labeled PR Impact: minor The PR is small in size and might only require a quick look of a knowledgeable reviewer Process: release backport Integration Process: The PR is a release backport of a change previously provided to master Type: bug The issue reports a bug / The PR fixes a bug (including spelling errors)
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants