Skip to content

Comments

Change documentation theme to Clarity#2578

Open
liborjelinek wants to merge 5 commits intoflintlib:mainfrom
ReadCraft-io:main
Open

Change documentation theme to Clarity#2578
liborjelinek wants to merge 5 commits intoflintlib:mainfrom
ReadCraft-io:main

Conversation

@liborjelinek
Copy link

  • Remove deprecated default CSS file and switch to sphinx_clarity_theme for documentation styling.
  • Enhance index.rst with captions for better structure and clarity.
  • Introduce requirements.txt for Sphinx dependencies.
  • In GitHub Actions workflow for docs, add installation step for Python dependencies from requirements.txt

Closes #2574.

- Remove deprecated default CSS file and switch to sphinx_clarity_theme for documentation styling.
- Enhance index.rst with captions for better structure and clarity.
- Introduce requirements.txt for Sphinx dependencies.
- Add installation step for uv and Python dependencies in the GitHub Actions workflow.
@fredrik-johansson
Copy link
Collaborator

As I commented in the issue, I have a reservation about the reduced information density. Compare for example

https://flintlib.org/doc/gr_mat.html#solving

solving_old solving_new

@liborjelinek
Copy link
Author

liborjelinek commented Feb 12, 2026

Understand. I made it a bit dense with a little bit of custom CSS. What about now?

http://showcase.readcraft.io/flint/gr_mat.html#solving

CleanShot 2026-02-12 at 15 34 41@2x

@rburing
Copy link
Contributor

rburing commented Feb 12, 2026

The syntax highlighting (or lack thereof) makes it a lot harder to parse visually, the proposed theme has zero contrast between the different parts of the declaration.

@liborjelinek
Copy link
Author

Got it, very useful hint. Thanks. I've added a few more styles to mimic your current theme:

https://showcase.readcraft.io/flint/gr_mat.html#solving

CleanShot 2026-02-16 at 13 18 53@2x

I could easily make it appear more or less contrasted.

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.

Alternative docs theme experiment (no proposal)

3 participants