| Name | sphinx-ads JSON |
| Version |
0.0.2
JSON |
| download |
| home_page | https://github.com/useblocks/sphinx-ads |
| Summary | Sphinx extension for advertising between different Sphinx-Projects and other pages |
| upload_time | 2023-03-14 00:17:30 |
| maintainer | Daniel Woste |
| docs_url | None |
| author | team useblocks |
| requires_python | >=3.7.0,<4.0 |
| license | MIT |
| keywords |
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
Sphinx-Ads
==========
.. image:: https://img.shields.io/pypi/l/sphinx-ads.svg
:target: https://pypi.python.org/pypi/sphinx-ads
:alt: License
.. image:: https://img.shields.io/pypi/pyversions/sphinx-ads.svg
:target: https://pypi.python.org/pypi/sphinx-ads
:alt: Supported versions
.. image:: https://github.com/useblocks/sphinx-ads/actions/workflows/docs.yaml/badge.svg
:target: https://github.com/useblocks/sphinx-ads/actions/docs.yaml
:alt: GitHub Docs CI Action status
.. image:: https://github.com/useblocks/sphinx-ads/actions/workflows/ci.yaml/badge.svg
:target: https://github.com/useblocks/sphinx-ads/actions
:alt: GitHub CI Action status
.. image:: https://img.shields.io/pypi/v/sphinx-ads.svg
:target: https://pypi.python.org/pypi/sphinx-ads
:alt: PyPI Package latest release
.. image:: https://img.shields.io/badge/code%20style-black-000000.svg
:target: https://github.com/psf/black
:alt: black code style
Sphinx-Ads is an extension for the `Python <https://python.org>`_ based documentation framework `Sphinx <https://www.sphinx-doc.org>`_, 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
+++++++++
.. code-block:: bash
$ pip install sphinx-ads
From source
+++++++++++
.. code-block:: bash
$ 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:
.. code-block:: python
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 <http://sphinx-ads.useblocks.com/json-file.html>`_ 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:
.. code-block:: jinja
{% extends "!layout.html" %}
{% block footer %}
{{ super() }}
{{ advertisement() }}
{% endblock %}
Raw data
{
"_id": null,
"home_page": "https://github.com/useblocks/sphinx-ads",
"name": "sphinx-ads",
"maintainer": "Daniel Woste",
"docs_url": null,
"requires_python": ">=3.7.0,<4.0",
"maintainer_email": "daniel@useblocks.com",
"keywords": "",
"author": "team useblocks",
"author_email": "info@useblocks.com",
"download_url": "https://files.pythonhosted.org/packages/32/41/131aaaa645859b5fd7b5f2071a9fbd3c076938897f7af0ad79f6fb45613c/sphinx_ads-0.0.2.tar.gz",
"platform": null,
"description": "Sphinx-Ads\n==========\n\n.. image:: https://img.shields.io/pypi/l/sphinx-ads.svg\n :target: https://pypi.python.org/pypi/sphinx-ads\n :alt: License\n.. image:: https://img.shields.io/pypi/pyversions/sphinx-ads.svg\n :target: https://pypi.python.org/pypi/sphinx-ads\n :alt: Supported versions\n.. image:: https://github.com/useblocks/sphinx-ads/actions/workflows/docs.yaml/badge.svg\n :target: https://github.com/useblocks/sphinx-ads/actions/docs.yaml\n :alt: GitHub Docs CI Action status\n.. image:: https://github.com/useblocks/sphinx-ads/actions/workflows/ci.yaml/badge.svg\n :target: https://github.com/useblocks/sphinx-ads/actions\n :alt: GitHub CI Action status\n.. image:: https://img.shields.io/pypi/v/sphinx-ads.svg\n :target: https://pypi.python.org/pypi/sphinx-ads\n :alt: PyPI Package latest release\n.. image:: https://img.shields.io/badge/code%20style-black-000000.svg\n :target: https://github.com/psf/black\n :alt: black code style\n\n\nSphinx-Ads is an extension for the `Python <https://python.org>`_ based documentation framework `Sphinx <https://www.sphinx-doc.org>`_, which you can use to add advertisements from a central source to your Sphinx documentation website.\n\n* Docs: http://sphinx-ads.useblocks.com\n* Repo: https://github.com/useblocks/sphinx-ads\n\nInstallation\n------------\n\nWe recommend using the latest version of Python. Sphinx-Ads supports Python 3.7 and newer.\nAlso, we recommend using a virtual environment to manage the dependencies for your project, both in development and production.\n\nUsing pip\n+++++++++\n\n.. code-block:: bash\n\n $ pip install sphinx-ads\n\nFrom source\n+++++++++++\n\n.. code-block:: bash\n\n $ git clone https://github.com/useblocks/sphinx-ads\n $ cd sphinx-ads\n $ pip install .\n\nActivation\n++++++++++\n\nIn the **conf.py** file under your **docs** folder, you can set the values for the following options:\n\n.. code-block:: python\n\n extensions = [\"sphinx_ads\",]\n\n ads_path = \"ads.json\" # path to the JSON file containing the ad data.\n ads_url = \"https://example.org/ads.json\" # url link to the JSON data\n\n.. note::\n\n * You can set the values for either ``ads_path`` or ``ads_url`` and not both in your **conf.py** file.\n * Refer to the `Ads JSON file <http://sphinx-ads.useblocks.com/json-file.html>`_ documentation page for more information about the JSON file's data.\n\nCreate a **layout.html** file in the **_templates/** folder under your **docs/** folder. The HTML file should contain the following data:\n\n.. code-block:: jinja\n\n {% extends \"!layout.html\" %}\n {% block footer %}\n {{ super() }}\n {{ advertisement() }}\n {% endblock %}\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Sphinx extension for advertising between different Sphinx-Projects and other pages",
"version": "0.0.2",
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "11387de8470e12dfdfdd674d6512245346e2fcce08222b7d77cf408c9b4dc933",
"md5": "308bef3c45e9192a55698d93842b9a99",
"sha256": "4c80b7fd3f0523f86ee88a3c78e47bde240348b65e2dd672a83bea4b5b8cd2f2"
},
"downloads": -1,
"filename": "sphinx_ads-0.0.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "308bef3c45e9192a55698d93842b9a99",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7.0,<4.0",
"size": 12320,
"upload_time": "2023-03-14T00:17:29",
"upload_time_iso_8601": "2023-03-14T00:17:29.815049Z",
"url": "https://files.pythonhosted.org/packages/11/38/7de8470e12dfdfdd674d6512245346e2fcce08222b7d77cf408c9b4dc933/sphinx_ads-0.0.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "3241131aaaa645859b5fd7b5f2071a9fbd3c076938897f7af0ad79f6fb45613c",
"md5": "9d9f507399feacf929f22cdf399ca3ef",
"sha256": "d55564e841f7166290ff915ad143ab2742d43cd0741ce6fb65bc6caf5f5ce838"
},
"downloads": -1,
"filename": "sphinx_ads-0.0.2.tar.gz",
"has_sig": false,
"md5_digest": "9d9f507399feacf929f22cdf399ca3ef",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7.0,<4.0",
"size": 10518,
"upload_time": "2023-03-14T00:17:30",
"upload_time_iso_8601": "2023-03-14T00:17:30.992580Z",
"url": "https://files.pythonhosted.org/packages/32/41/131aaaa645859b5fd7b5f2071a9fbd3c076938897f7af0ad79f6fb45613c/sphinx_ads-0.0.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-03-14 00:17:30",
"github": true,
"gitlab": false,
"bitbucket": false,
"github_user": "useblocks",
"github_project": "sphinx-ads",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "sphinx-ads"
}
