pytorch-lightning icon indicating copy to clipboard operation
pytorch-lightning copied to clipboard

Light / dark mode for documentation

Open nbrosse opened this issue 1 year ago • 11 comments

📚 Documentation

The current lightning documentation is in dark mode https://lightning.ai/docs/pytorch/stable/. Would it be possible to switch from dark to light mode (or vice versa) ? It should not be difficult to implement such a feature and would improve the reading comfort. Thanks a lot !

cc @borda

nbrosse avatar Nov 05 '24 09:11 nbrosse

Seconding this. Especially because the math equations are still in black, so when it is in dark mode you can't read them.

juliawang22 avatar Nov 08 '24 21:11 juliawang22

Same issue for some code snippets, such as yaml:

grafik

Source: https://lightning.ai/docs/pytorch/stable/cli/lightning_cli_advanced_3.html

dmholtz avatar Nov 13 '24 09:11 dmholtz

good call, will check it... cc: @lantiga

Borda avatar Nov 13 '24 10:11 Borda

@nbrosse if you log in and set your theme to light mode, then docs will be in light mode we'll consider giving the possibility to change when logged out

the issue that @juliawang22 and @dmholtz surfaced absolutely needs to be fixed, thanks for surfacing!

lantiga avatar Nov 18 '24 23:11 lantiga

I think this is a template issue and setting contrast colours...

Borda avatar Nov 19 '24 08:11 Borda

@nbrosse if you log in and set your theme to light mode, then docs will be in light mode we'll consider giving the possibility to change when logged out

the issue that @juliawang22 and @dmholtz surfaced absolutely needs to be fixed, thanks for surfacing!

Ok thanks, yes would be nice to change when logged out 😄

nbrosse avatar Nov 19 '24 09:11 nbrosse

In the home-assistant docs you can simply toggle light/dark, I think this is preferable vs a global setting (which I cannot find) as sometimes you do want to switch between these modes

robmarkcole avatar Jan 02 '25 09:01 robmarkcole

Please consider providing a light mode. The black mode sometimes is suffering

cszhbo avatar Mar 14 '25 07:03 cszhbo

The PyTorch Lightning portal presents the same document in the light mode:

https://pytorch-lightning.readthedocs.io/en/2.5.1/pytorch

mzweilin avatar Apr 23 '25 22:04 mzweilin

Bump. This is really hard to read and I am getting old. Even in the docs on the pytorch-lightning site, which are light themed, have dark code snippets. Same is true for older versions (<2.5) on the lightning site.

Image

lendle avatar May 17 '25 05:05 lendle

For me the whole page is unreadable and even if I manually change the theme to light it doesn't change (using Ubuntu + Chrome in dark mode)

Image

Edit: just realized that this problem only occurs for the forum, not the docs

tobiasatnoah avatar May 22 '25 07:05 tobiasatnoah

I second this, there is a problem with the forum webpage; basically not usable.

https://lightning.ai/forums/t/why-might-speed-stay-the-same-when-moving-from-1-gpu-to-8-gpus-ddp/136

valhassan avatar Jul 23 '25 17:07 valhassan