Installation

Python Version

We recommend using the latest version of Python. Sphinx-Ads supports Python 3.7 and newer.

Virtual environments

Use a virtual environment to manage the dependencies for your project, both in development and production.

Python comes bundled with the venv module to create virtual environments.

Create an environment

Create a project folder and a venv folder within:

macOS/Linux

$ mkdir myproject
$ cd myproject
$ python3 -m venv .venv

Windows

> mkdir myproject
> cd myproject
> python -m venv .venv

Activate the environment

Before you work on your project, activate the corresponding environment:

macOS/Linux

$ .venv/bin/activate

Windows

> .venv\Scripts\activate

Install Sphinx-Ads

Within the activated environment, use the following command to install Sphinx-Ads:

Using pip

$ pip install sphinx-ads

From source

$ git clone https://github.com/useblocks/sphinx-ads
$ cd sphinx-ads
$ pip install .

You can refer to the Quickstart section for a good introduction to Sphinx-Ads.