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.

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

Jump to bottom

Support Dark Mode for Pytest Docs Website #12290

Closed
cverrier opened this issue May 6, 2024 · 5 comments
Closed

Support Dark Mode for Pytest Docs Website #12290

cverrier opened this issue May 6, 2024 · 5 comments
Labels
type: docs documentation improvement, missing or needing clarification

Comments

@cverrier
Copy link

cverrier commented May 6, 2024

What's the problem this feature will solve?

Reading the documentation in the evening can be quite uncomfortable due to the current (very bright) theme of the docs website.

Describe the solution you'd like

Having the option to turn on/off a dark theme for the docs website.
@The-Compiler
Copy link
Member

We use the Pallets Sphinx theme which doesn't seem to offer a dark mode.

It looks like even Pallets has plans to switch to Furo which does.

Maybe we should reevaluate #6402 (where we ended up upgrading our theme to upstream Pallets in #6453) and instead adopt Furo? I'd be +1 on that.

@nicoddemus
Copy link
Member

👍 from me too, however I probably won't have time to work on this, but would be happy to review the work if someone does tackle this.

@jwk33
Copy link

jwk33 commented May 7, 2024

👍 I'm all for dark mode docs everywhere. I'd like to have a go at this, though I suspect a switch to Furo might mean a few design changes to the site. It would be useful to use this issue to discuss the design if it's the right forum to do so.

@Zac-HD Zac-HD added the type: docs documentation improvement, missing or needing clarification label May 13, 2024
@samjirovec samjirovec mentioned this issue May 15, 2024
Merged
@samjirovec
Copy link
Contributor

Hey all, I took some time to do a quick conversion from Flask to Furo. Only big design change was with the side-nav turning into a note + the main side-nav now being scrollable.

#12326

The-Compiler pushed a commit that referenced this issue May 21, 2024
@samjirovec
Issue #12290 - Docs using Furo Theme W/ Dark Mode (#12326)
cbf6bd9 
* furo theme for docs site

* removing duplicate tocs from deprecations and reference pages

* removing pallets references in code and config

* reverting trainings to sidebar

* removed sphinx style and unpinned packaging version

* updated styles
github-actions bot pushed a commit that referenced this issue May 21, 2024
@samjirovec @pytestbot
[8.2.x] Issue #12290 - Docs using Furo Theme W/ Dark Mode
eb8a7c9
nicoddemus pushed a commit that referenced this issue May 21, 2024
@github-actions @samjirovec
[8.2.x] Issue #12290 - Docs using Furo Theme W/ Dark Mode (#12348)
f0e7a07 
Co-authored-by: Sam Jirovec <47160720+samjirovec@users.noreply.github.com>
@cverrier
Copy link
Author

Thanks a lot @samjirovec, I tried the dark mode and it looks really good! 🚀

Since this feature has already been merged with commit cbf6bd9, I will close this issue.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
type: docs documentation improvement, missing or needing clarification
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
6 participants
@The-Compiler @nicoddemus @Zac-HD @cverrier @samjirovec @jwk33