You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
 
Pradyun Gedam 9f41ee678d
Add initial theme.conf content for eventual ablog support
4 days ago
.github Rework the asset generation setup 9 months ago
docs Retitle the reference section 1 month ago
src/furo Add initial theme.conf content for eventual ablog support 4 days ago
.flake8 Checkin skeleton 2 years ago
.gitattributes Add git stuff 2 years ago
.gitignore Switch to webpack 9 months ago
.isort.cfg We have a name: furo! 2 years ago
.pre-commit-config.yaml [pre-commit.ci] pre-commit autoupdate (#487) 2 weeks ago
.readthedocs.yaml Make the RTD install the theme for use 6 months ago
CODE_OF_CONDUCT.md 🎨 2 years ago
LICENSE Checkin skeleton 2 years ago
README.md Fix the Just the Docs link 3 months ago
noxfile.py Switch from optional-dependencies to dedicated requirements.txt files 6 months ago
package-lock.json Update npm dependencies 2 months ago
package.json Add an explicit dependency on sass 2 months ago
postcss.config.js Add autoprefixer to webpack build pipeline 9 months ago
pyproject.toml Bump to the latest Node.js LTS 3 months ago
webpack.config.js Add autoprefixer to webpack build pipeline 9 months ago

README.md

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.