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

🔧 MAINTAIN: Drop furo-specific stylesheet #22

Merged
merged 5 commits into from
Apr 20, 2022

Conversation

pradyunsg
Copy link
Member

Furo is gonna add styles for supporting this extension directly. This can be merged once I make a Furo release with the relevant changes.

@codecov-commenter
Copy link

Codecov Report

Merging #22 (9cbd7ab) into main (6930a00) will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##             main      #22   +/-   ##
=======================================
  Coverage   88.82%   88.82%           
=======================================
  Files          10       10           
  Lines         859      859           
=======================================
  Hits          763      763           
  Misses         96       96           
Flag Coverage Δ
pytests 88.82% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.


Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 6930a00...9cbd7ab. Read the comment docs.

@chrisjsewell
Copy link
Member

Cross post question: pradyunsg/furo#111 (comment)

I don’t see this css in furo yet?

@pradyunsg
Copy link
Member Author

pradyunsg commented Oct 16, 2021

@chrisjsewell I'm unlikely to make the change you've asked for in that comment.

As far as I am concerned, this stylesheet is completely wrong, since https://pradyunsg.me/furo/changelog/#beta39. I've overridden everything that this sets in Furo, and if you want sphinx-design to be usable in the current versions of Furo, it'd be best to just straight up drop this stylesheet IMO.

I'll defer to others on whether this should be merged or not. I'll note that if this PR gets rejected, I intend to remove the sphinx-design-specific stylesheets from Furo and also remove the relevant sections recommending/advertising support from Furo's documentation.

@chrisjsewell
Copy link
Member

chrisjsewell commented Oct 17, 2021

if you want sphinx-design to be usable in the current versions of Furo, it'd be best to just straight up drop this stylesheet IMO.
if this PR gets rejected, I intend to remove the sphinx-design-specific stylesheets from Furo and also remove the relevant sections recommending/advertising support from Furo's documentation.

I'm a bit surprised by this comment, it feels a bit aggressive, no?

Just to clarify, this stylesheet is not part of the sphinx-design package, it is only used for the internal documentation, i.e. there is nothing for Furo to override unless users specifically choose to add this CSS to their package (outside of using the sphinx-design extension)
So I'm a little unclear why you feel this is such a critical issue?

This is not to say I'm against removing it.
As mentioned pradyunsg/furo#111, the only reason I added it was there were some issues with a few uses of elements in the documentation being visible in both light and dark mode; for example, if you create a black outline button then it is fine in light mode, but effectively invisible in dark mode.
It's a relatively niche case, but it brings in to question what it means to specify a dark/light color in such an adaptive theme

I would have imagined the more critical issue would be #21, which I was still hoping for a reply from you 😬

@pradyunsg
Copy link
Member Author

I'll defer to others on whether this should be merged or not. I'll note that if this PR gets rejected, I intend to remove the sphinx-design-specific stylesheets from Furo and also remove the relevant sections recommending/advertising support from Furo's documentation.

Apologies for this. This is frustration from elsewhere creeping into the wrong place. I spent the whole day fighting the browser and some other drama -- triaging my own open PRs after that wasn't the best plan. 😓

I'm a bit surprised by this comment, it feels a bit aggressive, no?

Indeed.

I was still hoping for a reply from you 😬

Yep, I'll update that today. :)

@pradyunsg
Copy link
Member Author

I still do suggest dropping this stylesheet entirely -- having this means that the users don't get a representative view of how the extension will behave in their documentation, which... isn't ideal. :)

@chrisjsewell
Copy link
Member

Ah yeh no worries, we've all been there lol. I'll try to get this sorted soon 👍

@chrisjsewell
Copy link
Member

Ok so:

As it is now; after #21, with furo==2021.7.5b38, and with the stylesheet

Light:
image

Dark:
image


with furo==2021.7.5b38, but no stylesheet

Light:
image

Dark:
image


With furo==2021.10.09, no stylesheet

Light:
image

Dark:
image

@chrisjsewell
Copy link
Member

So are you going to keep these new overrides, which take it away from the look of #21 (comment) 😬

@pradyunsg
Copy link
Member Author

You're missing an important detail: there's a dark mode toggle in Furo. :)

@chrisjsewell
Copy link
Member

You're missing an important detail: there's a dark mode toggle in Furo

but what does that change?

@pradyunsg
Copy link
Member Author

With dark mode on your browser, click the moon-like button on the top of the content a few times. It'll be broken when the on-page toggle gets to light mode. Likewise for the other way around.

I'll tweak things over on Furo's end once this makes it into a release, and I can test it easily. :)

@chrisjsewell
Copy link
Member

I'll tweak things over on Furo's end once this makes it into a release, and I can test it easily. :)

Now released BTW. Have a play around and then let me know 👍

@pradyunsg
Copy link
Member Author

What's the blockers to merging this again?

@chrisjsewell
Copy link
Member

What's the blockers to merging this again?

will circle back around to this soon 😬

Copy link
Member

@chrisjsewell chrisjsewell left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Cheers @pradyunsg, sorry this fell off my radar a bit!

@chrisjsewell chrisjsewell changed the title Drop furo-specific stylesheet 🔧 MAINTAIN: Drop furo-specific stylesheet Apr 20, 2022
@chrisjsewell chrisjsewell merged commit 93955f5 into executablebooks:main Apr 20, 2022
@pradyunsg pradyunsg deleted the drop-furo-css branch April 20, 2022 20:37
@pradyunsg
Copy link
Member Author

No worries, cheers! :)

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.

3 participants