Furo
A clean customisable Sphinx documentation theme.
Elevator pitch
- Intentionally minimal --- the most important thing is the content, not the scaffolding around it.
- Responsive --- adapting perfectly to the available screen space, to work on all sorts of devices.
- Customisable --- change the color palette, font families, logo and more!
- Easy to navigate --- with carefully-designed sidebar navigation and inter-page links.
- Good looking content --- through clear typography and well-stylised elements.
- Good looking search --- helps readers find what they want quickly.
- Biased for smaller docsets --- intended for smaller documentation sets, where presenting the entire hierarchy in the sidebar is not overwhelming.
Quickstart
Furo is distributed on PyPI. To use the theme in your Sphinx project:
-
Install Furo in documentation's build environment.
pip install furo
-
Update the
html_themeinconf.py.html_theme = "furo"
-
Your Sphinx documentation's HTML pages will now be generated with this theme! 🎉
For more information, visit Furo's documentation.
Contributing
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.
Acknowledgements
Furo is inspired by (and borrows elements from) some excellent technical documentation themes:
- mkdocs-material for MkDocs
- Just the Docs for Jekyll
- GitBook
- pdoc3
We use BrowserStack to test on real devices and browsers. Shoutout to them for supporting OSS projects!
What's with the name?
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!
Used By
I'm being told that mentioning who uses
$thingis a good way to promote$thing.
- urllib3 -- THE first adopter of Furo
- attrs -- one of the early adopters!
- pip -- what I wrote this for
- Python Developer’s Guide
- Blender -- the popular 3D suite
- black
License
This project is licensed under the MIT License.
1 maintainer
Release files for furo 2025.12.19
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| furo-2025.12.19.tar.gz | 1.7 MB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| furo-2025.12.19-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 2.0 MB
Release files / furo-2025.12.19.tar.gz
| Download URL | furo-2025.12.19.tar.gz |
|---|---|
| Size | 1.7 MB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
188d1f942037d8b37cd3985b955839fea62baa1730087dc29d157677c857e2a7
|
|
BLAKE2b-256 checksum How to use checksums |
ec205f5ad4da6a5a27c80f2ed2ee9aee3f9e36c66e56e21c00fde467b2f8f88f
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.2.0 CPython/3.14.2
|
Release files / furo-2025.12.19-py3-none-any.whl
| Download URL | furo-2025.12.19-py3-none-any.whl |
|---|---|
| Size | 339.3 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
bb0ead5309f9500130665a26bee87693c41ce4dbdff864dbfb6b0dae4673d24f
|
|
BLAKE2b-256 checksum How to use checksums |
f4b250e9b292b5cac13e9e81272c7171301abc753a60460d21505b606e15cf21
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.2.0 CPython/3.14.2
|
