Installation

The sphinx-versioned-docs project has the following requirements.

Requirements

GitPython>=3.1.31
loguru>=0.7.0
setuptools>=66.0.0
sphinx>=4.6.0
typer>=0.9.0

Now, it can be installed via the following methods:

1. Installing using pip

For this you will require that python3 and pip are already installed.

$ pip install sphinx-versioned-docs

2. Installing using conda

In this method, please make sure that anaconda/conda is properly installed:

$ conda install sphinx-versioned-docs

In order to create a separate environment in conda, follow these instructions:

$ conda create --name versioned
$ conda activate versioned
$ conda install sphinx-versioned-docs

3. Installing from source

This method typically installs that lastest developer version of the package, however, it be used to install stable branches too.

To install the latest developer version:

$ git clone https://github.com/devanshshukla99/sphinx-versioned-docs
$ cd sphinx-versioned-docs
$ pip install .

To install the latest stable release, specified via the <release tag>:

$ git clone https://github.com/devanshshukla99/sphinx-versioned-docs
$ cd sphinx-versioned-docs
$ git checkout <release tag>
$ pip install .

4. Installing the developer version

If you are interested in contributing to the project, then you can setup the developer environment by using:

$ git clone https://github.com/devanshshukla99/sphinx-versioned-docs
$ cd sphinx-versioned-docs
$ pip install -e .[all]