Skip to content
forked from pradyunsg/furo

A clean customizable documentation theme for Sphinx

License

Notifications You must be signed in to change notification settings

YosysHQ/furo-ys

This branch is 33 commits ahead of, 8 commits behind pradyunsg/furo:main.

Folders and files

NameName
Last commit message
Last commit date

Latest commit

3cf6331 Â· Nov 28, 2024
Nov 28, 2024
Nov 28, 2024
Nov 28, 2024
Sep 2, 2023
Apr 27, 2024
Aug 15, 2020
Nov 11, 2021
May 8, 2024
Nov 28, 2024
Feb 18, 2022
Aug 30, 2020
May 8, 2024
Dec 7, 2022
Jun 8, 2024
Jun 8, 2024
Nov 28, 2024
Jul 2, 2024
Nov 15, 2021
Nov 28, 2024
May 8, 2024

Repository files navigation

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
    
  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! 🎉

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

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

License

This project is licensed under the MIT License.

About

A clean customizable documentation theme for Sphinx

Resources

License

Code of conduct

Stars

Watchers

Forks

Languages

  • Sass 31.8%
  • Python 24.0%
  • HTML 22.6%
  • JavaScript 12.1%
  • SCSS 9.5%