Warning: This document is for the development version of sphinxcontrib-versioning. The latest version is v2.2.1.


Getting started is pretty simple. The first step is to install the library.

Pip Install

The easiest way to get SCVersioning is to use pip. Simply run this command.

pip install sphinxcontrib-versioning

Latest from GitHub

You can also elect to install the latest bleeding-edge version by using pip to install directly from the GitHub repository.

pip install git+https://github.com/Robpol86/sphinxcontrib-versioning.git

Clone and Install

Lastly you can also just clone the repo and install from it. Usually you only need to do this if you plan on contributing to the project.

git clone git@github.com:Robpol86/sphinxcontrib-versioning.git
cd sphinxcontrib-versioning
python setup.py install