Contents Menu Expand Light mode Dark mode Auto light/dark mode
sphinx-basic-ng
sphinx-basic-ng
  • Goals
  • Expectations

Usage

  • Getting Started
  • Skeleton
  • Components
    • Breadcrumbs
    • “Edit this page” link
    • Ethical Ads
    • Site Logo
    • Related Pages
    • “Hide search matches” link
    • Search input
    • Sidebar Drawer Toggles
    • “View this page” link
  • Glossary

Project

  • Development
  • Design
  • Changelog
  • License
  • GitHub
Back to top

Site Logo#

Sphinx allows users to set a logo for their site, using the [html_logo][sphinx-html_logo] variable in conf.py. Themes are expected to have this on the page, if provided by the user.

Usage#

{% include "components/logo.html" %}

If the logo is set, this adds an img.site-logo with the correct URL for the logo. Otherwise, this is empty.

Configurability#

None.

Next
Related Pages
Previous
Ethical Ads
Copyright © 2023, Pradyun Gedam
Made with Sphinx and @pradyunsg's Furo
On this page
  • Site Logo
    • Usage
    • Configurability