Home

Awesome

<h1 align="center">Furo</h1> <p align="center"> A clean customisable <a href="https://www.sphinx-doc.org/">Sphinx</a> documentation theme. </p> <a href="https://pradyunsg.me/furo/"> <img align="center" src="https://github.com/pradyunsg/furo/raw/main/docs/_static/demo.png" alt="Demo image"> </a>

Elevator pitch

<!-- start elevator-pitch --> <!-- end elevator-pitch -->

Quickstart

<!-- start quickstart -->

Furo is distributed on PyPI. To use the theme in your Sphinx project:

  1. Install Furo in documentation's build environment.

    pip install furo
    
  2. Update the html_theme in conf.py.

    html_theme = "furo"
    
  3. Your Sphinx documentation's HTML pages will now be generated with this theme! 🎉

<!-- end quickstart -->

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!

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

<!-- start used-by -->

I'm being told that mentioning who uses $thing is a good way to promote $thing.

<!-- end used-by -->

License

This project is licensed under the MIT License.