Sphinx extension for advertising between different Sphinx-Projects and other pages
Project description
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.
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
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 %}
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for sphinx_ads-0.0.2-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 4c80b7fd3f0523f86ee88a3c78e47bde240348b65e2dd672a83bea4b5b8cd2f2 |
|
MD5 | 308bef3c45e9192a55698d93842b9a99 |
|
BLAKE2b-256 | 11387de8470e12dfdfdd674d6512245346e2fcce08222b7d77cf408c9b4dc933 |