installation

The recommended method of installation is using pip:

pip install sphinx-alice-theme
    (or)
python -m pip install sphinx-alice-theme

To verify the package has been installed, the following command can be used:

sphinx_alice_theme --version
    (or)
python -m sphinx_alice_theme --version

quick-start

The following provides a series of steps to assist in preparing a new environment to use this package. This quick-start will aim to use the most recent version of Python.

linux

While the use of Python/pip is almost consistent between Linux distributions, the following are a series of helpful steps to install this package under specific distributions of Linux. From a terminal, invoke the following commands:

arch

$ sudo pacman -Sy
$ sudo pacman -S python-pip
$ sudo pip install sphinx-alice-theme
$ sphinx_alice_theme --version
sphinx-alice-theme <version>

centos

$ sudo yum install epel-release
$ sudo yum install python-pip
$ sudo pip install sphinx-alice-theme
$ sphinx_alice_theme --version
sphinx-alice-theme <version>

fedora

$ sudo dnf install python-pip
$ sudo pip install sphinx-alice-theme
$ sphinx_alice_theme --version
sphinx-alice-theme <version>

opensuse

$ pip install sphinx-alice-theme
$ sphinx_alice_theme --version
sphinx-alice-theme <version>

ubuntu

$ sudo apt-get update
$ sudo apt-get install python-pip
$ sudo pip install sphinx-alice-theme
$ sphinx_alice_theme --version
sphinx-alice-theme <version>

os x

From a terminal, invoke the following commands:

$ sudo easy_install pip
$ sudo pip install sphinx-alice-theme
$ sphinx_alice_theme --version
sphinx-alice-theme <version>

windows

If not already installed, download the most recent version of Python:

When invoking the installer, it is recommended to select the option to “Add Python to PATH”; however, users can explicitly invoked Python from an absolute path (the remainder of these steps will assume Python is available in the path).

Open a Windows command prompt and invoke the following:

> python -m pip install sphinx-alice-theme
> python -m sphinx_alice_theme --version
sphinx-alice-theme <version>

development

To install the most recent development sources, the following pip command can be used:

pip install git+https://github.com/jdknight/sphinx-alice-theme.git