-
Notifications
You must be signed in to change notification settings - Fork 5.7k
Docs Visual Overhaul #2841
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.
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
Docs Visual Overhaul #2841
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
- Color of border buttons are now more subtle and don't 'stand out' that much.
- Fixes the white line on the sidebar border
these are really nice, good idea 👍
- The top white separator line at the beginning of each page was made the same color as background.
Mh, the line is also there in the light theme - maybe just make it a bit more subtle?
- Example box is now a bit rounded to look a bit modern.
I'd prefer to keep this as is, since the boxes arent't changed on the light theme and bc IMHO it doesn't really fit with the rest of the theme …
👍🏼
Maybe its time to update the light theme too? We can also make the boxes like warnings, notes, etc (slightly) 'rounded'. I'll also think about adding a toggle to switch between light and dark mode |
There are cool ways to do toggles without JS, I researched that a while ago. E.g. https://daveyhert.hashnode.dev/how-to-create-animated-toggle-switches-with-just-css-and-implement-a-dark-mode-feature |
IMO this should then also cover the boxes for reference links, inline monospace text attribute/method names and so on. Personally, I'm fine with the non-round boxes … Ofc if you enjoy fiddling with CSS, I won't be the buzzkill :) However, it's probably worth to first look around for already existing sphinx themes that you/we like better than the current one.
should have expected you to say something like that 😄 AFAIK removing JS just for the sake of it isn't always the right thing to do, though |
How about furo? even comes with a dropdown thingy that could be used for the bot methods table |
@harshil21 https://pradyunsg.me/furo/kitchen-sink/sphinx-design/ Furo basically comes with some 3rd party dep for that |
Also use linkcode for styling [source]
Also a tiny doc fix
Would be nice to build docs for this branch to test the new theme on mobile |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Noice! Left some nitpicks. Build is up at https://python-telegram-bot.readthedocs.io/en/dark-mode-adjust/
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Nice addition! LGTM. @Poolitzer do you want to have a look before we merge?
@Bibo-Joshi yes, today or tomorrow |
words can't express how much I love that overhaul, amazing job. Do we need an auto switch though in the dark light button? Can't we just have it set the proper auto theme, and then users can manually set it to the other if they want? |
but the point of the auto theme is that it switches automatically when light/dark mode is enabled? |
@harshil21 But why? Are you constantly switching your browsers theme preferences while visiting a website? |
Visual changes:
furo
theme.Code changes:
4.3.2
Other changes:
jobqueue.py