Metadata-Version: 2.1
Name: sphinx_eso_theme
Version: 1.1.1
Summary: ESO theme for Sphinx
License: ESO
Description-Content-Type: text/markdown
Requires-Dist: sphinx
Requires-Dist: sphinx-rtd-theme

Usage
=====

The `sphinx_eso_theme` is an HTML theme that use `sphinx_rtd_theme` as base and customize it to add
ESO logo, favicon and custom footer.

To use this theme, install theme and create a new sphinx project with e.g. `sphinx-quickstart` and
modify configuration file `conf.py`:

```py
import sphinx_eso_theme

extensions = [
    ...
    "sphinx_eso_theme",
]

html_theme = 'sphinx_eso_theme'

# The following HTML options are also recommended, but not necessary:
html_copy_source = True
html_show_sourcelink = False
html_show_sphinx = False
```

Installation
============

System-wide installation:

```sh
python setup.py install
```

Install to user:

```sh
python setup.py install --user
```

Building Example
================

Building example does not require installation. Simply run from the repo root:

```sh
make -C example html
```

and the project is built to example/build.
