Sphinx emoji favicon

A simple sphinx extension to add emoji favicon to your sphinx site.

This extension is inspired by sphinx-favicon and streamlit.

Other related projects:

• carpedm20/emoji
• twitter/twemoji

Installation

pip install sphinx-emoji-favicon

Usage

Add sphinx_emoji_favicon to your conf.py:

extensions = [
    ...
    "sphinx_emoji_favicon",
    ...
]

Then add the following to your conf.py:

emoji_favicon = "🦄"
# or emoji_favicon = ":unicorn:"
# or emoji_favicon = ":独角兽:"

or with additional options:

emoji_favicon = {
    "emoji": ":lion:",  # "Leo" in English
    "language": "fr",
    "twemoji_cdns": "https://cdn.staticfile.org/twemoji/",  # or with version and/or assets type: "https://cdn.staticfile.org/twemoji/13.1.0/72x72/"
}