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-adsFrom 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 dataCreate 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 %}1 maintainer
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
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file sphinx_ads-0.0.2.tar.gz.
File metadata
- Download URL: sphinx_ads-0.0.2.tar.gz
- Upload date:
- Size: 10.5 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via:
poetry/1.4.0 CPython/3.9.16 Linux/5.15.0-1034-azure
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
d55564e841f7166290ff915ad143ab2742d43cd0741ce6fb65bc6caf5f5ce838
|
|
| MD5 |
9d9f507399feacf929f22cdf399ca3ef
|
|
| BLAKE2b-256 |
3241131aaaa645859b5fd7b5f2071a9fbd3c076938897f7af0ad79f6fb45613c
|
File details
Details for the file sphinx_ads-0.0.2-py3-none-any.whl.
File metadata
- Download URL: sphinx_ads-0.0.2-py3-none-any.whl
- Upload date:
- Size: 12.3 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via:
poetry/1.4.0 CPython/3.9.16 Linux/5.15.0-1034-azure
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
4c80b7fd3f0523f86ee88a3c78e47bde240348b65e2dd672a83bea4b5b8cd2f2
|
|
| MD5 |
308bef3c45e9192a55698d93842b9a99
|
|
| BLAKE2b-256 |
11387de8470e12dfdfdd674d6512245346e2fcce08222b7d77cf408c9b4dc933
|
