botan icon indicating copy to clipboard operation
botan copied to clipboard

Proposal: Use furo theme for Sphinx docs

Open securitykernel opened this issue 2 years ago • 4 comments

We currently use the readthedocs theme for publishing documentation on https://botan.randombit.net with Sphinx.

I recently discovered the furo theme for Sphinx, which is used by pip, python-gitlab, urllib3 and more. IMHO it looks much cleaner than readthedocs, and optionally allows the user to switch to dark mode. Below are some screenshots for comparison. I also uploaded a full recent Botan docs made with furo to https://docs.botan-crypto.org/furo/ to browse.

Start page

image image

Building The Library

image image

Random Number Generators

image image

TLS Code Example

image image

What do you think?

securitykernel avatar Dec 01 '23 17:12 securitykernel

No objection here

randombit avatar Dec 01 '23 18:12 randombit

Does this add a dependency and require installing an extra Sphinx theme furo?

If so, shouldn't building.md tell that it's necessary for docs target, and how to install it?

mouse07410 avatar Dec 03 '23 00:12 mouse07410

It is not required. Just like before with the readthedocs theme, it will fall back to the agogo theme shipped with Sphinx automatically if furo is not found.

securitykernel avatar Dec 03 '23 06:12 securitykernel

@randombit I would love it if the official Botan website could switch to this theme. Currently it is only used as the default in the build scripts (if available), but not on the official site.

I think long sites like e.g. https://botan.randombit.net/handbook/api_ref/pubkey.html would benefit a lot of the better navigation via the sidebar that duro provides compared to the theme currently used.

lieser avatar Mar 05 '24 10:03 lieser