pygame-ce icon indicating copy to clipboard operation
pygame-ce copied to clipboard

New website style + docs sorting modifications

Open bilhox opened this issue 1 year ago โ€ข 13 comments
trafficstars

Hello,

This PR aims to change the website style after years of no modifications. I understand this is considered as a BIG UI change and there is a huge talk on the topic, so I want to make you understand the old theme isn't gone ! Indeed, the goal is to propose for the moment the new style only for static doc generation. Furthermore, the default style when generating docs is the old style, if you want to test the new website style, make sure to read docs/README.md, a small paragraph was added.

Any feedbacks would be considered as a great opportunity to progress on this idea ! I hope you like the new style.

bilhox avatar Jun 13 '24 19:06 bilhox

After some reviews with Damus, we found that there is a problem a problem of opacity on links with a feature when you hover it, you get some kind of infos about it. In the meantime, some parts of the documentation have been reworked as it doesn't follow the style of other docs pages.

bilhox avatar Jun 16 '24 08:06 bilhox

In the meantime, some parts of the documentation have been reworked as it doesn't follow the style of other docs pages.

If you want to change content in the docs, do it in a separate PR. That doesn't belong in this PR.

Starbuck5 avatar Jun 16 '24 23:06 Starbuck5

I wanted to check out the style, so I switched the theme in conf.py and installed the additional package. But it fails to build.

PS C:\Users\charl\Desktop\pygame-ce> python setup.py docs --f
WARNING: This command is deprecated and will be removed in the future.
Please use the following replacement: `C:\Users\charl\AppData\Local\Programs\Python\Python39\python.exe buildconfig\make_docs.py full_generation`

Executing sphinx in subprocess with args: ['C:\\Users\\charl\\AppData\\Local\\Programs\\Python\\Python39\\python.exe', '-m', 'sphinx', '-b', 'html', '-d', 'docs\\generated\\doctrees', '-D', 'headers_dest=src_c\\doc', '-D', 'headers_mkdirs=0', 'docs\\reST', 'docs\\generated', '-E']
Running Sphinx v7.1.2
C:\Users\charl\AppData\Local\Programs\Python\Python39\lib\site-packages\sphinxcontrib\applehelp\__init__.py:24: RemovedInSphinx80Warning: The alias 'sphinx.util.SkipProgressMessage' is deprecated, use 'sphinx.util.display.SkipProgressMessage' instead. Check CHANGES for Sphinx API modifications.
  from sphinx.util import SkipProgressMessage, progress_message
C:\Users\charl\AppData\Local\Programs\Python\Python39\lib\site-packages\sphinxcontrib\applehelp\__init__.py:24: RemovedInSphinx80Warning: The alias 'sphinx.util.progress_message' is deprecated, use 'sphinx.http_date.epoch_to_rfc1123' instead. Check CHANGES for Sphinx API modifications.
  from sphinx.util import SkipProgressMessage, progress_message
building [mo]: targets for 0 po files that are out of date
writing output...
building [html]: targets for 98 source files that are out of date
updating environment: [new config] 98 added, 0 changed, 0 removed
reading sources... [100%] tutorials/ko/๋นจ๊ฐ„๋ธ”๋ก ๊ฒ€์€๋ธ”๋ก/๊ฐœ์š”
looking for now-outdated files... none found
pickling environment... done
checking consistency... done
preparing documents... WARNING: unsupported theme option 'home_uri' given
done
copying assets... copying static files... done
copying extra files... done
done
writing output... [  1%] c_api
Extension error (pydata_sphinx_theme):
Handler <function update_and_remove_templates at 0x00000221BDA35670> for event 'html-page-context' threw an exception (exception: 'dict object' has no attribute 'image_relative')

---
For help with compilation see:
    https://github.com/pygame-community/pygame-ce/wiki/Compiling-on-Windows
To contribute to pygame-ce development see:
    https://github.com/pygame-community/pygame-ce
---

Failed to build documentation

Starbuck5 avatar Jul 11 '24 07:07 Starbuck5

image I like this new docs theme. But IMO, using green based colors would be better.

image Why 2 seperate colors(orange happens when hovering over a link). I think it'd be better if the docs used only blue or green for link colors.

The docs also need to use the new pygame-ce logo.

image This color could be changed.

Notenlish avatar Sep 08 '24 08:09 Notenlish

image Would it be possible to move the contents so it aligns with the search bar? Also can we get rid of the line to the left of contents

Notenlish avatar Sep 08 '24 08:09 Notenlish

The docs also need to use the new pygame-ce logo.

Yes I didn't update the branch yet.

bilhox avatar Sep 08 '24 08:09 bilhox

Why 2 seperate colors(orange happens when hovering over a link). I think it'd be better if the docs used only blue or green for link colors.

For the moment, this version directly uses the theme installed, I did no modification to it. I think I'll be moving it to custom themes so we can do changes on the colors and everything. (maybe next week)

bilhox avatar Sep 08 '24 08:09 bilhox

image Would it be possible to move the contents so it aligns with the search bar? Also can we get rid of the line to the left of contents

image I was thinking about something like this this could be done by just using position: relative; in the container and then setting position: fixed and top: [some value]; in the contents element.

Notenlish avatar Sep 08 '24 08:09 Notenlish

image

What if we made the background of the code example white, and then simply just added background shadow?

something like this: image

Notenlish avatar Sep 08 '24 09:09 Notenlish

image this should be 2023 - 2024 i think, not sure though

Notenlish avatar Sep 08 '24 09:09 Notenlish

image Colors for dark theme definitely need to be changed

Notenlish avatar Sep 08 '24 09:09 Notenlish

image The color contrast is bad when hovering over the items

same thing happens in dark theme too: image

Notenlish avatar Sep 08 '24 09:09 Notenlish

image Why is there an element to purposefully add margin bottom to make the sidebar have a scrollbar, even if the sidebar contains few items.

weird choice by the theme makers

Notenlish avatar Sep 08 '24 09:09 Notenlish