A clean customisable Sphinx documentation theme.
Furo is distributed on PyPI. To use the theme in your Sphinx project:
Install Furo in documentation's build environment.
pip install furo
html_theme = "furo"
Your Sphinx documentation's HTML pages will now be generated with this theme! 🎉
For more information, visit Furo's documentation.
Furo is a volunteer maintained open source project, and we welcome contributions of all forms. Please take a look at our Contributing Guide for more information.
Furo is inspired by (and borrows elements from) some excellent technical documentation themes:
We use BrowserStack to test on real devices and browsers. Shoutout to them for supporting OSS projects!
I plucked this from the scientific name for Domesticated Ferrets: Mustela putorius furo.
A ferret is actually a really good spirit animal for this project: cute, small, steals little things from various places, and hisses at you when you try to make it do things it doesn't like.
I plan on commissioning a logo for this project (or making one myself) consisting of a cute ferret. Please reach out if you're interested!
I'm being told that mentioning who uses
$thingis a good way to promote
I'm also a maintainer on the last two, so... that covers responsible disclosure. :)
This project is licensed under the MIT License.