Sphinx-Ads

Sphinx-Ads is an extension for the Python based documentation framework Sphinx, which you can use to add advertisements from a central source to your Sphinx documentation website.

• Docs: http://sphinx-ads.useblocks.com
• Repo: https://github.com/useblocks/sphinx-ads

Installation

We recommend using the latest version of Python. Sphinx-Ads supports Python 3.7 and newer. Also, we recommend using a virtual environment to manage the dependencies for your project, both in development and production.

Using pip

$ pip install sphinx-ads

From source

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

Activation

In the conf.py file under your docs folder, you can set the values for the following options:

extensions = ["sphinx_ads",]

ads_path = "ads.json"   # path to the JSON file containing the ad data.
ads_url = "https://example.org/ads.json"    # url link to the JSON data

Note

• You can set the values for either ads_path or ads_url and not both in your conf.py file.
• Refer to the Ads JSON file documentation page for more information about the JSON file's data.

Create a layout.html file in the _templates/ folder under your docs/ folder. The HTML file should contain the following data:

{% extends "!layout.html" %}
{% block footer %}
{{ super() }}
{{ advertisement() }}
{% endblock %}