Enable Dark Mode in docs page

[JaynouOliver]

https://docs.kedro.org/en/stable/#

It is quite difficult to view the page in light mode in dark. Although we all use an extension but it is better to have a dark mode button that can switch the color

[PranavJayachandran]

I am interested. Can you assign this issue to me?

[astrojuanlu]

Hi @JaynouOliver, @PranavJayachandran, thanks for your interest! Note that Kedro uses sphinx-rtd-theme at the moment, so for us to have a dark mode we would have to either

• Contribute that upstream Dark theme readthedocs/sphinx_rtd_theme#224 (issue opened in 2015), or
• Adopt a completely new Sphinx theme Consider more modern theme for docs #2394

Feel free to work on any of these, no need to get assigned to it.

[astrojuanlu]

Finally, in our opinion this is a difficult task so in principle we are not labeling it for Hacktoberfest. Unless we see a mostly-ready pull request on time, of course!

[JaynouOliver]

Sure, I will a look upon it and start working on it. Thank you for providing me the details.

[JaynouOliver]

Finally, in our opinion this is a difficult task so in principle we are not labeling it for Hacktoberfest. Unless we see a mostly-ready pull request on time, of course!

Sure, I am not doing this for the sake of Hacktoberfest, nor did I mention it anywhere to get the issue labelled. I was actually going through the docs when I struck upon this idea, thanks a lot

[stichbury]

I'm really pleased to see this. However, one warning I should give you is that we have some outstanding design changes to come in the docs. The ticket is still awaiting our team to look at it #4257 but there will be a redesign in future, so your work could be short-lived if we move to a different theme or even build tool when it is addressed.

[JaynouOliver]

Ok I didn't knew about that. How much time may that take to get deployed to production?

[stichbury]

@JaynouOliver At present, it's not on our priority list (based on feedback from user research). We have a Kedro 0.19 release to come out first and then we'll circle back to docs redesign. So there will not be any updates to switch away from our current theme in 2023. We could take in an update for dark mode in the short-term.

That probably isn't very helpful since it means you risk doing work now that will be brought into Kedro but may drop out again when we do decide how to proceed with a new theme/updates to current them/updates to toolchain. However, I would say that the Sphinx RTD theme maintainers would probably still appreciate a dark mode contribution because regardless of whether Kedro continues to use it, others will.

[JaynouOliver]

So what shall I do? shall I proceeded with the code?

[astrojuanlu]

Go ahead @JaynouOliver ! As long as we don't change the theme, we'll be happy to have a look at the contribution.

[stichbury]

@JaynouOliver I can't really decide for you because I can't commit your time 😄 but if you want to make a contribution for dark mode then it would be welcome. We could potentially use it until such time as we redesign, and maybe after, but cannot guarantee it.

[JaynouOliver]

ok

[stichbury]

Closing this ticket because it will form part of a broader update to the documentation design covered by #4257 (and if completed standalone would cause more problems than it solves because of #3416).

I will note that dark mode is something to add as a requirement when we cover the redesign.