Alternative docs theme experiment (no proposal)

[liborjelinek]

Hi,
I’ve been using FLINT recently and spent some time browsing the documentation.

I noticed the docs are still using an older Sphinx theme, which is, of course, completely fine and functional. Out of curiosity, I made a small fork where I tried rendering the same documentation with a different Sphinx theme, just as a side experiment.

I’m not suggesting any change, but I thought I’d share the preview in case you find it interesting or useful to look at.

– new docs: https://readcraft-io.github.io/showcase-flint/
– fork: https://github.com/ReadCraft-io/showcase-flint

If this isn’t something you want to consider, feel free to ignore this — I just wanted to share the experiment.

Thanks for maintaining FLINT 🙏

[albinahlback]

I think this looks really nice, and it would be nice with a change. @fredrik-johansson @edgarcosta

[edgarcosta]

I agree! I really struggle with the current theme, and the lack of dual side navigation.

[liborjelinek]

Okay, thank you, guys. So I could prepare a pull request with proposed changes to the Flint repo. All doc URLs and the content of all .rst documents will remain 100% the same.

[vneiger]

Another +1 here, thanks a lot!!

[liborjelinek]

Continues as PR #2575.

[fredrik-johansson]

Not a fan of the reduced information density, with increased whitespace and 1/2 of the screen taken up by sidebars. It would be better if the sidebars were at least collapsible.

[albinahlback]

Not a fan of the reduced information density, with increased whitespace and 1/2 of the screen taken up by sidebars. It would be better if the sidebars were at least collapsible.

We can always change the CSS to touch up a few things

[fredrik-johansson]

Also, this theme seems to have a noncommercial use-only license. That's a no-go.

[liborjelinek]

Also, this theme seems to have a noncommercial use-only license. That's a no-go.

Thanks for flagging this — you’re absolutely right. It's free for non-commercial and open-source use.

I, as the author of the Clarity theme, chose the non-commercial license to prevent unbounded reuse, but I don’t want it to block legitimate open-source projects.

For FLINT specifically, I’m happy to grant an explicit exception allowing use of the theme for your documentation, under a permissive, OSS-compatible license, limited to this project.

If that works for you, I can put this in writing (LICENSE file or a short grant notice) so it’s clear and auditable.

[liborjelinek]

Hi again, @albinahlback, @fredrik-johansson, and @edgarcosta!

I would like to thank you for your previous feedback, which led me to the release of the Clarity theme under the MIT License for everyone and the Commercial License for companies (dual license) (details at https://readcraft.io/license/).

It also means Clarity can be installed with pip install sphinx_clarity_theme (no binary wheels anymore). --> I wish to ask you for permission to post a new PR?

[edgarcosta]

Please do.