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
Metadata
1 maintainer
Release files for sphinx-ads 0.0.2
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| sphinx_ads-0.0.2.tar.gz | 10.5 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| sphinx_ads-0.0.2-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 22.8 kB
Release files / sphinx_ads-0.0.2.tar.gz
| Download URL | sphinx_ads-0.0.2.tar.gz |
|---|---|
| Size | 10.5 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
d55564e841f7166290ff915ad143ab2742d43cd0741ce6fb65bc6caf5f5ce838
|
|
BLAKE2b-256 checksum How to use checksums |
3241131aaaa645859b5fd7b5f2071a9fbd3c076938897f7af0ad79f6fb45613c
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
poetry/1.4.0 CPython/3.9.16 Linux/5.15.0-1034-azure
|
Release files / sphinx_ads-0.0.2-py3-none-any.whl
| Download URL | sphinx_ads-0.0.2-py3-none-any.whl |
|---|---|
| Size | 12.3 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
4c80b7fd3f0523f86ee88a3c78e47bde240348b65e2dd672a83bea4b5b8cd2f2
|
|
BLAKE2b-256 checksum How to use checksums |
11387de8470e12dfdfdd674d6512245346e2fcce08222b7d77cf408c9b4dc933
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
poetry/1.4.0 CPython/3.9.16 Linux/5.15.0-1034-azure
|
