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

Use sphinx-nefertiti theme #53

Closed

Conversation

danirus
Copy link

@danirus danirus commented Nov 29, 2024

Hello there, I have developed a Sphinx theme called Nefertiti for Sphinx, that I think it is slightly better than the sphinx_rtd_theme. I have updated your docs/conf.py to give it a try with your project. I would very much like if you would decide to use it. I will attach a screenshot of how chatnoir-resiliparse's docs look with it.
Screenshot 2024-11-29 at 23 00 11

I hope you like it.
I have done a bit of customization to add the logo. Also, the :no-index: I add to the docs/api/parse/html.rstis to avoid one of the warnings when build the docs.
Thanks :-)

@phoerious
Copy link
Member

Thanks. The theme looks good overall, but I'm not a fan of the grey background. It reduces the text contrast by a lot.

@danirus
Copy link
Author

danirus commented Dec 2, 2024

I pushed a change to style.css that changes the background-color when the user prefers the light color-scheme. It overwrites the background color to white. Having the background as white makes a bit more difficult to distinguish the background of code blocks. Maybe it can be overwritten with pygments. I will check.

@danirus
Copy link
Author

danirus commented Dec 2, 2024

I have tried a few different values for pygments_light_style, in the setting html_theme_options, in conf.py. Some of them give a bit more contrast between the white background and the color of code blocks. But it is a matter of personal choice. I could suggest you any of gruvbox-light, paraiso-light, solarized-light, or tango. A list of available pygments are here. I haven't tested all of them.

@phoerious
Copy link
Member

phoerious commented Dec 2, 2024

It's certainly more than just personal preference.
image

The red does pass the AAA requirements, but due to the colour combination, it almost looks worse than the grey text.

@danirus
Copy link
Author

danirus commented Dec 2, 2024

Thanks for considering it anyway.
All the best to you 🙂

@danirus danirus closed this Dec 2, 2024
@phoerious
Copy link
Member

Nonetheless, thanks for suggesting.

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.

2 participants