Change doc theme to Furo

powsybl / pypowsybl

A PowSyBl and Python integration based on GraalVM native image

Mozilla Public License 2.0

55 stars 12 forks source link

Change doc theme to Furo #727

Closed pet-mit closed 6 months ago

pet-mit commented 6 months ago

Please check if the PR fulfills these requirements

[ ] The commit message follows our guidelines
[ ] Tests for the changes have been added (for bug fixes / features)
[ ] Docs have been added / updated (for bug fixes / features)

What kind of change does this PR introduce?

Doc theme change

What is the current behavior?

pydata theme is used

What is the new behavior (if this is a feature change)? Changing theme to furo allows a better dark mode + enabling an edit button

Does this PR introduce a breaking change or deprecate an API?

[ ] Yes
[x] No

HugoKulesza commented 6 months ago

I'm not sure about the rendering of network area diagrams and single line diagrams in dark mode with this change (see User Guide -> Network Visualization for example). The former style had a light background for them that made them readable, it is not the case with this new theme. @pet-mit

pet-mit commented 6 months ago

I'm not sure about the rendering of network area diagrams and single line diagrams in dark mode with this change (see User Guide -> Network Visualization for example). The former style had a light background for them that made them readable, it is not the case with this new theme. @pet-mit

nice catch the thing is that these SVG files do not have a background. I'm not sure if it was a feature or a bug in PyData, but I believe that Furo was doing its job "too well" by not adding a background behind the SVG ; instead letting it lay on a black background.

I added some CSS styling to force a white background on SVGs that don't have any.