Skip to content

Latest commit

 

History

History
48 lines (32 loc) · 1.31 KB

README.md

File metadata and controls

48 lines (32 loc) · 1.31 KB

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.