Skip to content

Rebrand and clean up Sphinx CSS #2334

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

Closed
nicolaskruchten opened this issue Mar 30, 2020 · 5 comments · May be fixed by itsalways5am/plotly.py#13 or itsalways5am/plotly.py#20
Closed

Rebrand and clean up Sphinx CSS #2334

nicolaskruchten opened this issue Mar 30, 2020 · 5 comments · May be fixed by itsalways5am/plotly.py#13 or itsalways5am/plotly.py#20
Labels
documentation written for humans P3 backlog

Comments

@nicolaskruchten
Copy link
Contributor

Two things:

  1. We need to rebrand https://plotly.com/python-api-reference/ with the new colors (let's leave the fonts alone for now)
  2. We need to tweak the CSS a bit to better-format the markup that comes out of Sphinx

Re the latter, here's what comes to mind:

  • reformat blockquote so it doesn't look like a quote and doesn't make the text bigger
  • reformat dt/dd so that the terms aren't bold and the definitions are a bit indented
  • maybe add a bit of whitespace above/below li to make things breathe a bit?
@nicolaskruchten
Copy link
Contributor Author

In terms of how: cd doc/apidoc && make html to build it... Hopefully all this stuff is just a set of "overrides" in https://github.com/plotly/plotly.py/blob/master/doc/apidoc/_static/plotly-style.css

@nicolaskruchten
Copy link
Contributor Author

Ah, small and annoying wrinkle: it's hard/impossible to correctly build the entire docs on MacOS due to its case-insensitive filesystem.

Probably best to use the inspector stylesheet or something to do this :(

@nicolaskruchten
Copy link
Contributor Author

While trying to see how easy this inspector-stylesheet approach is to use, I basically ended up implementing most of the points in part 2 here... sorry! a78442b

@gvwilson
Copy link
Contributor

@LiamConnors is this still an open concern?

@LiamConnors
Copy link
Member

the page looks okay to me. I'm not certain on the reasons for the original issue and what was worked on. Closing it out

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation written for humans P3 backlog
Projects
None yet
4 participants