furomon 2022.1.4

A clean customisable Sphinx documentation theme based on furo.

Furomon

Forever Scalable

Furomon is a clean customisable Sphinx documentation theme based on Furo by Pradyun Gedam.

Furomon, the mount Furo, a Chakma word which means the mountain which pierced through Earth. It teaches us to be firm and determined against all odds.

Features

• 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

Furomon is distributed on PyPI. To use the theme in your Sphinx project:

1. Install Furomon in documentation's build environment.

   pip install furomon
   

2. Update the html_theme in conf.py.

   html_theme = "furomon"
   

3. Your Sphinx documentation's HTML pages will now be generated with this theme! 🎉

Donate🎁

In order to for us to maintain this project and grow our community of contributors. Donate

Getting Help

Community

For discussions about the usage, development, and the future of quo, please join our Google community

• Community👨‍👩‍👦‍👦

Resources

Bug tracker

If you have any suggestions, bug reports, or annoyances please report them to our issue tracker at Bug tracker or send an email to:

📥 [e-mail] | [e-mail]

License📑

This software is licensed under the MIT License. See the License file in the top distribution directory for the full license text.

Code of Conduct

Code of Conduct is adapted from the Contributor Covenant, version 1.2.0 available at Code of Conduct