botan icon indicating copy to clipboard operation
botan copied to clipboard

Published 20 hours ago • verified publisher icon randombit

Proposal: Use furo theme for Sphinx docs

Open securitykernel opened this issue 7 months 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