Metadata-Version: 2.1
Name: sphinx-emoji-favicon
Version: 0.1
Summary: A simple sphinx extension to add emoji favicons to html pages.
Home-page: https://github.com/DeepPSP/sphinx-emoji-favicon
Author: DeepPSP
Author-email: wenh06@gmail.com
License: MIT
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.7
Description-Content-Type: text/markdown
Requires-Dist: sphinx
Requires-Dist: docutils
Requires-Dist: emoji

# Sphinx emoji favicon

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

This extension is inspired by [sphinx-favicon](https://github.com/tcmetzger/sphinx-favicon) and [streamlit](https://github.com/streamlit/streamlit).


## Installation

```bash
pip install sphinx-emoji-favicon
```

## Usage

Add `sphinx_emoji_favicon` to your `conf.py`:

```python
extensions = [
    ...
    'sphinx_emoji_favicon',
    ...
]
```

Then add the following to your `conf.py`:

```python
emoji_favicon = '🦄'
# or emoji_favicon = ':unicorn:'
# or emoji_favicon = ':独角兽:'
```
