René's URL Explorer Experiment

Title: Dark theme by septatrix · Pull Request #44 · python/python-docs-theme · GitHub

Open Graph Title: Dark theme by septatrix · Pull Request #44 · python/python-docs-theme

X Title: Dark theme by septatrix · Pull Request #44 · python/python-docs-theme

Description: Closes #43. Closes #101. Update: I now consider this ready I have made a crude dark them as requested in #43, however there are still many unfinished areas. So far I've always tested based on the datetime.rst file from the official docs as an example, though this does not use all styles which need to be changed. TODO General areas Implement basic dark theme functionality Implement proper dark mode syntax highlighting (merged for Sphinx 3.0) Check complete docs for missing styles (e.g. find where .refcount and .stableabi are used) Add functionality to toggle theme (persistence would require JS or server side code) Maybe add small disclaimer on first visit to show how to change to dark theme (decided not to as it is just another annoying banner like cookies on other websites) Add dark mode compatible variants of images (e.g. pathlib images - maybe open issue in cpython repo) or alternatively add a white background for now (out of scope and has to be done in the python repo) Components / Classes Check contrast ratios Fix styles for highlights after a search (kinda, feedback welcome; too bright makes text unreadable, too dark makes highlights hard to spot; went for a halfway point but maybe an outline is better) Scrollbars (#44 (comment)) Sidebar collapse panel Notes Design decisions I choose the current main background color based on the header on python.org and went for a different one (#121212 from material design guidelines) for the background color around the edges as I thought this added a bit more depth to it. On second thought however it may be better to go with the single color approach as it is in the official docs. If we then were to the use the darker one this would also improve contrast and leave more space for fine tuning e.g. the anchor/link color. Most other colors are just from experimenting with the color wheel and by what felt right. The background for syntax however still needs to change but for that topic also see below. Syntax highlighting As neither Sphinx nor Pygments support switching themes based on a media query right now this would need to be a bit hacky. I might create an issue there and ask if they would be fine with pull request implementing such functionality (in whatever way though I already have an idea). Otherwise we would need to include another stylesheet after pygments.css overwriting the normal one. Theme toggling As not everybody likes to always have a dark theme it may be a good idea to implement theme switching functionality. This could be achieved using either CSS and some label/input magic or plain ole JS (or server side). CSS would be very accessible but not persistent. Therefore I think we should use the CSS way but save the state in a cookie (like we already do for whether the sidebar is expanded or not). Try it out Live version Updated somewhat regularly: https://septatrix.github.io/cpython-dark-docs/ Screenshot (outdated) Full size screenshot - rather large

Open Graph Description: Closes #43. Closes #101. Update: I now consider this ready I have made a crude dark them as requested in #43, however there are still many unfinished areas. So far I've always tested based on t...

X Description: Closes #43. Closes #101. Update: I now consider this ready I have made a crude dark them as requested in #43, however there are still many unfinished areas. So far I've always tested based ...

Opengraph URL: https://github.com/python/python-docs-theme/pull/44

X: @github

direct link

Domain: github.com

Links:

Viewport: width=device-width