-
-
Notifications
You must be signed in to change notification settings - Fork 193
Description
Documentation Styling Modification
I think that the documentation styling that pygame-ce uses should be modified. Even though the dark theme addition made the documentation a little bit more modern, I still think that the documentation looks quite old. For some time @NOTMEE12, @Sjmarf, @bilhox, me and more have been working on some mockups/generating ideas.
Modern Look
The documentation should be modern and easy to read. Currently it looks like this:
Accessibility
Responsive
Currently the responsivity of the website especially for mobile devices is bad.
Created Mockups
Figma link: pygame-ce documentation mockups
Example documentation repo by @bilhox
https://github.com/bilhox/pygame_website_example
@NOTMEE12 also has a PR open currently to add a sidebar and make navigation easier in the documentation. #2225
After this PR gets merged, a new pr should be opened to address this issue. Also related issue: #2227
Activity
NOTMEE12 commentedon Jun 26, 2023
few new mockups:

all of those are on figma page
I'm waiting to see which mockup we should use.
joereynolds commentedon Oct 5, 2023
Chiming in as an outsider, I see no reason why we're writing our own themes when Sphinx has really good well-tested themes that we can
pip install
?This one for example needs very few modifications to make it look "Pygamey". All we need to add is the ghastly green colour (which imo is also a major eyesore)
That being said, I do like the reorginsation of the content that you've put in.
"Most useful stuff", "Advanced stuff" and "Other" are terrible headers with no value.
edit:
I had a play around with the "Insegel" theme which is found here and got promising results.
A bit of reorganisation of the content and maybe small hints of a nice shade of green would go a long way.
bilhox commentedon Oct 5, 2023
Hello,
That's exactly what we want 😂, I don't know why I didn't look for other sphinx themes.
And yes, a bit of styling would be required so it looks more pygamey.
My website version is really similar to this one, I'll play a bit with the theme later.