Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/pradyunsg/furo
A clean customizable documentation theme for Sphinx
https://github.com/pradyunsg/furo
clean customizable documentation furo minimal sphinx sphinx-doc sphinx-theme theme three-column
Last synced: 10 days ago
JSON representation
A clean customizable documentation theme for Sphinx
- Host: GitHub
- URL: https://github.com/pradyunsg/furo
- Owner: pradyunsg
- License: mit
- Created: 2020-09-01T21:08:17.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2024-05-16T15:59:43.000Z (6 months ago)
- Last Synced: 2024-05-16T17:01:01.392Z (6 months ago)
- Topics: clean, customizable, documentation, furo, minimal, sphinx, sphinx-doc, sphinx-theme, theme, three-column
- Language: Sass
- Homepage: https://pradyunsg.me/furo/quickstart
- Size: 7.68 MB
- Stars: 2,487
- Watchers: 22
- Forks: 294
- Open Issues: 31
-
Metadata Files:
- Readme: README.md
- Contributing: docs/contributing/design.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
- awesome-starred - pradyunsg/furo - A clean customizable documentation theme for Sphinx (documentation)
- awesome-docs - Furo
README
Furo
A clean customisable Sphinx documentation theme.
## 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.
```text
pip install furo
```
2. Update the `html_theme` in `conf.py`.
```py
html_theme = "furo"
```
3. Your Sphinx documentation's HTML pages will now be generated with this theme! 🎉
[pypi]: https://pypi.org/project/furo/
For more information, visit [Furo's documentation][quickstart-docs].
[quickstart-docs]: https://pradyunsg.me/furo/quickstart
## Contributing
Furo is a volunteer maintained open source project, and we welcome contributions of all forms. Please take a look at our [Contributing Guide](https://pradyunsg.me/furo/contributing/) for more information.
## Acknowledgements
Furo is inspired by (and borrows elements from) some excellent technical documentation themes:
- [mkdocs-material] for MkDocs
- [Just the Docs] for Jekyll
- [GitBook]
- [pdoc3]
We use [BrowserStack] to test on real devices and browsers. Shoutout to them for supporting OSS projects!
[mkdocs-material]: https://squidfunk.github.io/mkdocs-material/
[just the docs]: https://just-the-docs.github.io/just-the-docs/
[gitbook]: https://www.gitbook.com/
[pdoc3]: https://pdoc3.github.io/pdoc/doc
[browserstack]: https://browserstack.com/
## What's with the name?
I plucked this from the scientific name for [Domesticated Ferrets](https://en.wikipedia.org/wiki/Ferret): 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`.
- [urllib3] -- THE first adopter of Furo
- [attrs] -- one of the early adopters!
- [pip] -- what I wrote this for
- [Python Developer’s Guide][devguide]
- [black]
[urllib3]: https://urllib3.readthedocs.io/
[attrs]: https://www.attrs.org/
[devguide]: https://devguide.python.org/
[pip]: https://pip.pypa.io/
[psycopg3]: https://www.psycopg.org/psycopg3/docs/
[black]: https://black.readthedocs.io/en/stable/
[pelican]: https://docs.getpelican.com/en/latest/
## License
This project is licensed under the MIT License.