A clean customisable Sphinx documentation theme.
Project description
Furo
A clean customizable theme for Sphinx.
Quickstart
Furo can be installed using pip:
pip install furo
Update the html_theme in conf.py:
html_theme = "furo"
Your Sphinx documentation 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!
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-2020.10.15b13.tar.gz.
File metadata
- Download URL: furo-2020.10.15b13.tar.gz
- Upload date:
- Size: 48.5 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/50.3.0 requests-toolbelt/0.9.1 tqdm/4.50.2 CPython/3.8.3
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 1ca504cdd7611b7b6eedd0999f52676212a9fa26c928e913ea4fb0acaceeada1 |
|
| MD5 | 61bc1604dbddef4901102c17d916f85e |
|
| BLAKE2b-256 | f9201b5d6cdc0ca7563cbc03fbdff13e7ba0175c68414583fe79eacf7146d946 |
Provenance
File details
Details for the file furo-2020.10.15b13-py3-none-any.whl.
File metadata
- Download URL: furo-2020.10.15b13-py3-none-any.whl
- Upload date:
- Size: 48.2 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/50.3.0 requests-toolbelt/0.9.1 tqdm/4.50.2 CPython/3.8.3
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 3d4d0cbe9c278c649b93b84d8df9911398982cf1649096c4178b3f22aa4c3a72 |
|
| MD5 | 2c8f5af2c40072ee53d7a08f50f40ad5 |
|
| BLAKE2b-256 | 5667533276c2ab046d641dc7e4104677f62dffa71d90e9b209bc56ca6472104b |
