File: logo.md

package info (click to toggle)
sphinx-basic-ng 1.0.0~beta2-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 504 kB
  • sloc: python: 179; makefile: 5
file content (18 lines) | stat: -rw-r--r-- 398 bytes parent folder | download | duplicates (2) 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
 
# 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

```jinja
{% 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.