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

Style changes when upgrading to Sphinx 4.1 #70

Closed
laurensvalk opened this issue Jul 14, 2021 · 4 comments
Closed

Style changes when upgrading to Sphinx 4.1 #70

laurensvalk opened this issue Jul 14, 2021 · 4 comments

Comments

@laurensvalk
Copy link
Member

A few things appear to have changed with v4.1. One noticable difference is that v3.X has method names in black, and arguments in gray. In v4 everything is just gray, which is slightly less readable.

Old (left), new (right)

image

@laurensvalk
Copy link
Member Author

laurensvalk commented Jul 14, 2021

Similarly, functions are now all blue, with the old style being clearer:

image

Old (left), new (right)

@dlech
Copy link
Member

dlech commented Jul 16, 2021

Upstream is working on it: readthedocs/sphinx_rtd_theme#1123

@laurensvalk
Copy link
Member Author

laurensvalk commented Jul 28, 2021

Meanwhile, the other blocking hacks have been removed, so we can upgrade once the aforementioned style issues are fixed upstream.

@laurensvalk laurensvalk added the blocked: upstream This issue is with a 3rd-party project and is out of scope of Pybricks label Jul 28, 2021
@laurensvalk
Copy link
Member Author

laurensvalk commented Aug 6, 2021

Upstream has committed a fix. Although not released yet, I might go ahead and pull this to considerably simplify work in #72.

It looks okay now. This is built with Sphinx 4.1 and the latest rtd theme.

image

One new minor change seems that literals may now break to a new line, but this is something we can look at another time.

@laurensvalk laurensvalk removed the blocked: upstream This issue is with a 3rd-party project and is out of scope of Pybricks label Aug 6, 2021
laurensvalk added a commit that referenced this issue Aug 6, 2021
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

No branches or pull requests

2 participants