sphinx-multiversion/docs/install.rst

.. _install:

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

You can install ``sphinx-multiversion`` via `pip <pip_>`_ or directly from :file:`setup.py`.

.. note::
   Since ``sphinx-multiversion`` is still under heavy development, it is not available on `PyPI <pypi_>`_ yet.

Install from GitHub
===================

You can install the latest development version using pip to install directly from the GitHub
repository.

.. code-block:: bash

    pip install git+https://github.com/Holzhaus/sphinx-multiversion.git

Install via :file:`setup.py`
============================

It's also possible to clone the Git repository and install the extension using its :file:`setup.py`:

.. code-block:: bash

    git clone https://github.com/Holzhaus/sphinx-multiversion.git
    cd sphinx-multiversion
    python setup.py install


.. _pip: https://pip.pypa.io/en/stable/
.. _pypi: https://pypi.org/