Skip to content
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

Webdesign #95

Open
wants to merge 6 commits into
base: master
Choose a base branch
from

Conversation

samanthahamilton
Copy link
Contributor

PR for changes to web design and layout

Files changed:

  • conf.py
  • index.rst
  • new custom.css file

No associated Issue.

Message :

Hi @ianhi!

You mentioned before I could "mess around" with the Sphinx design. I made some changes and additions to the layout, let me know what you think. I used Alabaster and Write the Docs for thematic context. The colour scheme is based on Matpotlib's icon (HEX 11557C) and the blue/green of the python code. The background (HEX fafafa RBG 250) is a tone based off the Sphinx margin grey (HEX efefef RBG 239).

Also, the cmd guide you left in the last PR worked, and my fork is now up to date with the repo 👍🏻

Cheers,
Sam.

Punctuation error on /index
Adding custom css to Sphinx
Updating conf.py file
As per the check, fixed the duplicate square bracket
As per the check... forgot the =
@ianhi
Copy link
Collaborator

ianhi commented Sep 3, 2020

Hiya, sorry I wasn't able to look at this until now. I got rather carried away with the rest of life/work

Also, the cmd guide you left in the last PR worked, and my fork is now up to date with the repo 👍🏻

🎉 🎉 rad 🎉 - I honestly wasn't entirely sure it would... so thanks for the followup

@ianhi
Copy link
Collaborator

ianhi commented Sep 24, 2020

A few notes:

  1. If you mouse over the items in TOC the text gets hidden:
    image
  2. Thoughts on deviating from blue for links? I think what you switched too looks nicer but theres also like 30 years of expectation built around links being blue:
    image
  3. This actually introduces two custom css files. One is already being injected here:
    https://github.com/ianhi/mpl-interactions/blob/fe449ffacffa22c9702a098be7ac6e1daa6dd71b/docs/conf.py#L99-L100
    (which I think is the more correct way? maybe... I think I got a warning when I tried to do it the way you did, and then I just copied something one of my friends had done)

So at the very least we'd need to fix the TOC mouse over. But overall I'm more ambivalent about these changes than I expected. I think that the RTD styling is nice because it is familiar to many users in the ecosystem. So maybe we shouldn't merge this unless there is a clear upside?

I will say that basing it off the matplotlib logo is super creative and I love the thought!

@samanthahamilton
Copy link
Contributor Author

Thanks for the feedback, I will take a look at these notes & changes on Monday!

updates re. feedback
@samanthahamilton
Copy link
Contributor Author

Hey @ianhi, I had some spare time to look over your comments today. Here are some thoughts:

If you mouse over the items in TOC the text gets hidden

Fixed

Thoughts on deviating from blue for links? I think what you switched too looks nicer but theres also like 30 years of expectation built around links being blue

I never thought of that, actually. Good point!! I changed them back to blue/purple.

This actually introduces two custom css files.

I used this procedure to create the CSS file and place it in the config file. I didn't add that "extra" file... maybe it gets added when the build occurs?? But I don't know.

overall I'm more ambivalent about these changes than I expected. I think that the RTD styling is nice because it is familiar to many users in the ecosystem.

If you're a fan of the RTD styling then by all means stick with that! I have just finished a full stack web developer course, and this was a great "proof of principle" activity... and something that I can refer back to as practice. I just fell in love with the Alabaster theme, and was trying to do something similar. Feel free to keep the files for future reference -- use them or not, it's at your discretion. But playing around with them was great fun, and now I know I can make other changes you might need.

Best,
Sam.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants