-
-
Notifications
You must be signed in to change notification settings - Fork 788
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: adopt a new theme: shibuya
#3754
Conversation
New and removed dependencies detected. Learn more about Socket for GitHub ↗︎
🚮 Removed packages: pypi/recommonmark@0.7.1, pypi/recommonmark@0.7.1, pypi/sphinx-rtd-theme@2.0.0, pypi/sphinx-rtd-theme@2.0.0 |
docs/conf.py
Outdated
# so a file named "default.css" will overwrite the builtin "default.css". | ||
html_theme = "shibuya" | ||
html_theme_options = { | ||
"accent_color": "plum", |
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.
It is possible to use another color theme, see https://shibuya.lepture.com/customisation/colors/#accent-colors for available options.
I picked "plum" because it is the closer color to the new logo (and it actually renders very well).
I can test other colors, if you would like to.
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.
Hello!
I just tried the colour palette from https://github.com/vyperlang/vyper-brand next to the radix palette you linked and I think Purple is the closest match, tonally:
![image](https://private-user-images.githubusercontent.com/80323528/300960564-5c6e5431-ab3d-4a5b-8d51-fbc97f01e949.png?jwt=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJnaXRodWIuY29tIiwiYXVkIjoicmF3LmdpdGh1YnVzZXJjb250ZW50LmNvbSIsImtleSI6ImtleTUiLCJleHAiOjE3MjU4NDA2MDYsIm5iZiI6MTcyNTg0MDMwNiwicGF0aCI6Ii84MDMyMzUyOC8zMDA5NjA1NjQtNWM2ZTU0MzEtYWIzZC00YTViLThkNTEtZmJjOTdmMDFlOTQ5LnBuZz9YLUFtei1BbGdvcml0aG09QVdTNC1ITUFDLVNIQTI1NiZYLUFtei1DcmVkZW50aWFsPUFLSUFWQ09EWUxTQTUzUFFLNFpBJTJGMjAyNDA5MDklMkZ1cy1lYXN0LTElMkZzMyUyRmF3czRfcmVxdWVzdCZYLUFtei1EYXRlPTIwMjQwOTA5VDAwMDUwNlomWC1BbXotRXhwaXJlcz0zMDAmWC1BbXotU2lnbmF0dXJlPTNiMmU4OWRiMGRiZmUxNGNmZmJkMTViOTQ1OWJjZGMzZDdiNjQ5NjA2MGJjNTk5Nzc2Y2E0ZTcxZTFhZjI4Y2QmWC1BbXotU2lnbmVkSGVhZGVycz1ob3N0JmFjdG9yX2lkPTAma2V5X2lkPTAmcmVwb19pZD0wIn0.qpIl-Qb5ueK0-ZxC19mUY0J1I-9K3UVn6My1dl5Pn-4)
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.
The color was updated from "plum" to "purple", and changes are live at https://vyper-tests.readthedocs.io. Thank you @pentcle!
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.
looks great, thank you @BoboTiG
Codecov ReportAll modified and coverable lines are covered by tests ✅
❗ Your organization needs to install the Codecov GitHub app to enable full functionality. Additional details and impacted files@@ Coverage Diff @@
## master #3754 +/- ##
==========================================
+ Coverage 84.78% 84.81% +0.02%
==========================================
Files 92 92
Lines 13139 13122 -17
Branches 2929 2933 +4
==========================================
- Hits 11140 11129 -11
+ Misses 1535 1530 -5
+ Partials 464 463 -1 ☔ View full report in Codecov by Sentry. |
9b24e0b
to
ab1395c
Compare
Not sure if it's just a config thing, but this test link is missing all of the older version docs + stable tag |
It's a config thing, it runs only from the PR branch for the demo. |
I just checked, this new theme will be available only starting from the "latest" version. It won't automatically be backported to old versions. And old versions won't be lost, I just did not enable them in the test project. Edit: I just enabled "master" to see how it looks. |
ab1395c
to
54265a5
Compare
@BoboTiG please don't force push to PRs that are in the middle of being reviewed! it makes it very hard to keep track of changes. |
I'll see to restore the sub navbar on the left 👍🏻 |
- move the right one to the left - adapt the main container to use the full width
How about now @charles-cooper? |
hmm @BoboTiG, if it costs us the ability to expand the submenus, let's move the navbar back to the right. |
can we also change the logo (on the top left) to the purple one? |
You were right: the colored logo on the top-left looks cooler 👍🏻 |
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.
cool. thanks!
shibuya
i'm realizing we need lower contrast. for the light mode, it would be nice to have some kind of grey/beige/off-white as the background (paging @pentcle ) |
There are updates for shibuya theme. Your current documentation has a UI issue: you can scroll down bellow the footer part. |
What I did
Upgraded the documentation website to another level 🍾
It brings a few things:
vyper.readthedocs.io
withdocs.vyperlang.org
Closes #3746.
How I did it
How to verify it
Go check https://vyper-tests.readthedocs.io 😃
Commit message
Description for the changelog
Migrated to the Shibuya theme for the documentation website.
Cute Animal Picture