=====================================================================
 Celery Sphinx Utilities
=====================================================================

:Version: 1.3.1
:Download: http://pypi.python.org/pypi/sphinx_celery/
:Source: http://github.com/celery/sphinx_celery/
:Keywords: Sphinx, documentation, python

About
=====

This project provides the Celery sphinx theme and common Sphinx utilities.

.. _installation:

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

You can install sphinx_celery either via the Python Package Index (PyPI)
or from source.

To install using `pip`,::

    $ pip install -U sphinx_celery

To install using `easy_install`,::

    $ easy_install -U sphinx_celery

.. _installing-from-source:

Downloading and installing from source
--------------------------------------

Download the latest version of sphinx_celery from
http://pypi.python.org/pypi/sphinx_celery/

You can install it by doing the following,::

    $ tar xvfz sphinx_celery.0.0.tar.gz
    $ cd sphinx_celery.0.0
    $ python setup.py build
    # python setup.py install

The last command must be executed as a privileged user if
you are not currently using a virtualenv.

.. _installing-from-git:

Using the development version
-----------------------------

With pip
~~~~~~~~

You can install the latest snapshot of sphinx_celery using the following
pip command::

    $ pip install https://github.com/celery/sphinx_celery#egg=sphinx_celery

