dnrops
/
furo
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
1,369 Commits 4 Branches 74 Tags 8.9 MiB
Sass 33.9%
HTML 23.6%
Python 19.2%
JavaScript 13.1%
SCSS 10.2%
Go to file
Pradyun Gedam 750fcd77fd
Prepare release: 2024.04.27 		2024-04-27 11:31:27 +01:00
.github Bump the github-actions group with 1 update (#777) 2024-04-07 23:29:42 +01:00
docs Update changelog 2024-04-27 11:27:20 +01:00
src/furo Prepare release: 2024.04.27 2024-04-27 11:31:27 +01:00
tests Test against Sphinx minor versions in CI 2023-09-02 12:48:04 +01:00
.gitattributes Add git stuff 2020-08-15 12:18:46 +05:30
.gitignore Switch to webpack 2021-11-11 19:47:26 +00:00
.isort.cfg We have a name: furo! 2020-09-02 02:10:47 +05:30
.pre-commit-config.yaml [pre-commit.ci] pre-commit autoupdate (#771) 2024-04-07 23:30:25 +01:00
.readthedocs.yaml Make the RTD install the theme for use 2022-02-18 09:46:08 +00:00
CODE_OF_CONDUCT.md 🎨 2020-08-30 23:46:43 +05:30
LICENSE Checkin skeleton 2020-08-14 16:18:32 +05:30
README.md Trim the list of adopters 2022-12-07 02:13:27 +00:00
noxfile.py Stop passing `reuse_venv` on nox sessions 2024-01-30 01:37:19 +00:00
package-lock.json Bump the npm group with 6 updates (#778) 2024-04-07 23:29:24 +01:00
package.json Bump the npm group with 6 updates (#778) 2024-04-07 23:29:24 +01:00
postcss.config.js Add autoprefixer to webpack build pipeline 2021-11-15 09:03:27 +00:00
pyproject.toml Rework infrastructure for linting 2023-09-09 23:48:32 +01:00
webpack.config.js Add autoprefixer to webpack build pipeline 2021-11-15 09:03:27 +00:00

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.