A clean customisable Sphinx documentation theme.
Project description
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
- psycopg3 -- another of the early adopters!
- black
License
This project is licensed under the MIT License.
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file furo-2022.6.21.tar.gz.
File metadata
- Download URL: furo-2022.6.21.tar.gz
- Upload date:
- Size: 1.7 MB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.1 CPython/3.9.12
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 9aa983b7488a4601d13113884bfb7254502c8729942e073a0acb87a5512af223 |
|
| MD5 | 9a1e88053831f4d7542dbfd822e70501 |
|
| BLAKE2b-256 | 50c10d7e678824341b920773cb24e1f40c292b3a84ebca552313bfba237b2113 |
Provenance
File details
Details for the file furo-2022.6.21-py3-none-any.whl.
File metadata
- Download URL: furo-2022.6.21-py3-none-any.whl
- Upload date:
- Size: 323.9 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.1 CPython/3.9.12
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 061b68e323345e27fcba024cf33a1e77f3dfd8d9987410be822749a706e2add6 |
|
| MD5 | fb331872d4d8a7d33f56aeb5df1f333f |
|
| BLAKE2b-256 | 7f6155188839be980df8686280522af0c32b8d7f42e6d42be37c53201638a8ee |
