Skip to content

Latest commit

 

History

History
39 lines (26 loc) · 1.76 KB

logo.md

File metadata and controls

39 lines (26 loc) · 1.76 KB

Adding a logo

Logos are a point of recognition and an important part of branding. Furo supports 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, using the 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_static_path = ["_static"]
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`][sphinx-html_static_path] folder. In the above example, that'd be `_static/logo-light-mode.png` and `_static/logo-dark-mode.png`.

This is different from how `html_logo` works, which copies the given filename into the correct location automagically.

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.