Convert Figma logo to code with AI

pradyunsg logofuro

A clean customizable documentation theme for Sphinx

2,684
309
2,684
40
View on GitHub

Top Related Projects

readthedocs's avatar

sphinx_rtd_theme

4,736

Sphinx theme from Read the Docs

Quick Overview

Furo is a clean, modern, and customizable theme for Sphinx documentation. It aims to provide a beautiful and responsive design that works well on both desktop and mobile devices, while offering easy customization options for users.

Pros

  • Clean and modern design that enhances readability
  • Responsive layout that works well on various screen sizes
  • Easily customizable with a wide range of configuration options
  • Good integration with Sphinx features and extensions

Cons

  • Limited to Sphinx documentation projects
  • May require some learning curve for users new to Sphinx theming
  • Some advanced customizations might require CSS and JavaScript knowledge

Getting Started

To use Furo in your Sphinx project, follow these steps:

  1. Install Furo using pip:
pip install furo
  1. In your Sphinx project's conf.py file, set the theme to Furo:
html_theme = "furo"
  1. Optionally, customize the theme by adding configuration options to conf.py:
html_theme_options = {
    "sidebar_hide_name": True,
    "light_css_variables": {
        "color-brand-primary": "#4B4B4B",
        "color-brand-content": "#069",
    },
}
  1. Build your Sphinx documentation as usual:
sphinx-build -b html source build

Your documentation will now use the Furo theme. Refer to the Furo documentation for more customization options and advanced features.

Competitor Comparisons

readthedocs logo

sphinx_rtd_theme

4,736

Sphinx theme from Read the Docs

Pros of sphinx_rtd_theme

  • Widely adopted and recognized in the Python documentation community
  • Extensive customization options through theme variables
  • Built-in support for mobile devices and responsive design

Cons of sphinx_rtd_theme

  • Less modern and sleek appearance compared to Furo
  • Can be more complex to customize and modify
  • Slower development cycle and less frequent updates

Code Comparison

sphinx_rtd_theme:

html_theme = 'sphinx_rtd_theme'
html_theme_options = {
    'navigation_depth': 4,
    'collapse_navigation': True,
    'sticky_navigation': True,
}

Furo:

html_theme = 'furo'
html_theme_options = {
    'sidebar_hide_name': True,
    'light_css_variables': {
        'color-brand-primary': '#4300FF',
        'color-brand-content': '#4300FF',
    },
}

Both themes offer configuration options, but Furo's approach is more streamlined and focuses on modern design principles. sphinx_rtd_theme provides more granular control over navigation, while Furo emphasizes customization through CSS variables for a cleaner, more contemporary look.

Convert Figma logo designs to code with AI

Visual Copilot

Introducing Visual Copilot: A new AI model to turn Figma designs to high quality code using your components.

Try Visual Copilot

README

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.