ansys / ansys-sphinx-theme

PyData-based Sphinx theme from the PyAnsys community
https://sphinxdocs.ansys.com
MIT License
22 stars 5 forks source link

Consider using the "friendly" pygments style as the default highlighting style #340

Closed jorgepiloto closed 8 months ago

jorgepiloto commented 8 months ago

🐞 Problem

The current syntax highlighting is out of sync with the rest of our theme. It's colors are pallid and not vibrant.

A common theme is the friendly style, by Pygments. This theme is more shiny and its colors better our corporate theme (from my point of view).

Of course, this is open to discussion. There are plenty of options, see available Pygment themes.

Sphinx provides the following option for setting a default theme:

pygments_style: str

However, it does not seem to work. Maybe, our template CSS takes priority over this option.

Ideally, we should override this by adding the CSS file we agree from this repo. License is UNLICENSE.txt. Thus, corporte usage is accepted. We can always include a small comment at the top of the style file.

greschd commented 8 months ago

As a side note: we need both a light and dark highlighting theme.

jorgepiloto commented 8 months ago

I guess we could go with monokai in that case for the dark theme. I think it is one of the most popular ones out there.

RobPasMue commented 8 months ago

I like monokai 😄 so works for me!