Skip to main content

A clean customisable Sphinx documentation theme.

Project description

Furo

A clean customizable theme for Sphinx.

Demo image

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:

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.

Project details


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

furo-2020.10.13b12.tar.gz (48.9 kB view hashes)

Uploaded Source

Built Distribution

furo-2020.10.13b12-py3-none-any.whl (48.7 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page