.. highlight:: shell

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


Stable release
==============

To install Sphinx TYPO3 theme, run this command in your terminal:

.. code-block:: console

    $ pip install sphinx-typo3-theme

This is the preferred method to install Sphinx TYPO3 theme, as it will always
install the most recent stable release.

If you don't have `pip`_ installed, this `Python installation guide`_ can guide
you through the process.

.. _pip: https://pip.pypa.io
.. _Python installation guide: http://docs.python-guide.org/en/latest/starting/installation/


.. commented out - to be reconsidered

   From sources
   ============

   The sources for Sphinx TYPO3 theme can be downloaded from the `Github repo`_.

   You can either clone the public repository:

   .. code-block:: console

       $ git clone git@github.com:typo3-documentation/sphinx_typo3_theme

   Or download the `tarball`_:

   .. code-block:: console

       $ curl -OJL https://github.com/typo3-documentation/sphinx_typo3_theme/tarball/master

   Once you have a copy of the source, you can install it with:

   .. code-block:: console

       $ python setup.py install


   .. _Github repo: https://github.com/typo3-documentation/sphinx_typo3_theme
   .. _tarball: https://github.com/typo3-documentation/sphinx_typo3_theme/tarball/master