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
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 (also one of the early adopters!)
- psycopg3
- pip
- packaging
I'm also a maintainer on the last two, so... that covers responsible disclosure. :)
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
Hashes for furo-2021.4.11b34-py3-none-any.whl
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 576a1dc1bcbe337d7c53cbc75b886802778a5964fd2e3324433d706066e9aea8 |
|
| MD5 | 22171e583daec330296629a37f2e4fe2 |
|
| BLAKE2b-256 | 8699a036bbba1bf879a4289f3b0016a872d6239ec94133b4e1930508bdc43f96 |
