Need help with furo?
Click the “chat” button below for chat support from the developer who created it, or find similar developers for support.

About the developer

pradyunsg
200 Stars 28 Forks MIT License 668 Commits 18 Opened issues

Description

A clean customizable documentation theme for Sphinx

Services available

!
?

Need anything else?

Contributors list

# 16,457
Django
pypy
cython
jython
652 commits
# 2,460
Python
Django
python-...
headles...
4 commits
# 23,362
Twitch
Less
nwjs
emberjs
2 commits
# 6,786
mac
pypi
nanogen...
prose
2 commits
# 30,234
Python
elastic...
time-se...
Flask
1 commit
# 25,659
driver
Postgre...
postgre...
Nim
1 commit
# 265,487
TeX
Shell
LaTeX
Common ...
1 commit

Furo

A clean customisable Sphinx documentation theme.

Demo image

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:

  1. Install Furo in documentation's build environment.
   pip install furo
  1. Update the
    html_theme
    in
    conf.py
    .
   html_theme = "furo"
  1. 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:

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.

From my perspective, a ferret is 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), consistenting of a cute ferret. Please reach out if you're interested!

Used By

I'm being told that mentioning who uses

$thing
is a good way to promote
$thing
.

I'm also a maintainer on the last two, so... that covers responsible disclosure. :)

License

This project is licensed under the MIT License.

We use cookies. If you continue to browse the site, you agree to the use of cookies. For more information on our use of cookies please see our Privacy Policy.