Contents Menu Expand
Furo is under active development, and this documentation is not written yet!
Furo
Furo
  • Quickstart
  • Customisation
    • Adding a logo
    • Changing landing page
    • Changing colors
    • Changing fonts
    • Hiding Contents sidebar
  • Reference
    • Text Formatting
    • Admonitions
    • API documentation
    • Code Blocks
    • Hyperlinks
    • Images
    • Lists
    • Tables
    • Tabs
    • Really Long Page
  • Recommendations

Development

  • Contributing
    • Workflow
    • Internals
    • Design Goals
  • Changelog
  • License
  • GitHub Repository

Adding a logo¶

Logos are a point of recognition and an important part of branding. Furo support adding your project’s logo at the top of the navigational (left) sidebar, like most other Sphinx themes.

Same logo for light and dark mode¶

Furo supports the standard Sphinx mechanism to add your project’s logo in the documentation.

This is done by setting standard html_logo variable in conf.py.

html_logo = "logo.png"

Different logos for light and dark mode¶

Furo also supports setting different logos for light and dark mode. This can be necessary if the project’s logo is transparent and does not maintain sufficient contrast with the background in both modes.

This is done by setting light_logo and dark_logo in html_theme_options in conf.py.

html_theme_options = {
    "light_logo": "logo-light-mode.png",
    "dark_logo": "logo-dark-mode.png",
}

The filenames must be relative to the html_static_path folder.

Related Information¶

It is also possible to hide the name of the project in the sidebar, which might be desirable if the logo contains the project name.

Next
Changing landing page
Previous
Customisation
Copyright © 2020, Pradyun Gedam | Built with Sphinx and @pradyunsg's Furo theme. | Show Source
Contents
  • Adding a logo
    • Same logo for light and dark mode
    • Different logos for light and dark mode
    • Related Information