Skip to content

feat(docs): Enable dark mode toggle #18285

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.

Sign up for GitHub

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

Closed
wants to merge 3 commits into from
Closed

feat(docs): Enable dark mode toggle #18285

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
5e237ce
Update Sphinx configuration for documentation
VedantSawant616 Oct 26, 2025
06f4d31
Merge remote-tracking branch 'apache/main' into patch-1
alamb Oct 27, 2025
0ee063e
Revert changes
alamb Oct 27, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions docs/source/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -89,6 +89,7 @@

html_theme_options = {
"use_edit_page_button": True,
"navbar_end": ["theme-switcher", "navbar-icon-links"],
Copy link
Contributor

@alamb alamb Oct 27, 2025

Choose a reason for hiding this comment

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

Pushed a commit that removed the extra copy of the config

However, when I tested this locally I didn't see any switcher buttons

@VedantSawant616 can you provide some help about how you tested / what I should look for?

Copy link
Author

@VedantSawant616 VedantSawant616 Oct 27, 2025 •
edited
Loading

Choose a reason for hiding this comment

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

hi @alamb, thanks for checking!

this is almost always a sphinx caching issue.
1.please run a clean build from the docs/directory(on windows cmd)

 make.bat clean && make.bat html

2.after that, you might also need to do a hard refresh in your browser

you would be able to see afterwards

Copy link
Contributor

@Jefffrey Jefffrey Oct 28, 2025

Choose a reason for hiding this comment

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

Can you provide a screenshot showing this is the case? I also tried locally and can't see the toggle, even with a hard refresh. Perhaps see @foskey51's comment for reference on what might need to be done 🤔

Copy link
Author

@VedantSawant616 VedantSawant616 Oct 28, 2025 •
edited
Loading

Choose a reason for hiding this comment

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

hi @Jefffrey, you're absolutely right, my apologies. my previous suggestion about the cache was incorrect.

i've just seen @foskey51 's very helpful comment and now understand that the docs/source/_templates/layout.html template was blocking the navbar. that's my mistake for missing that.

}

html_context = {
Expand Down