| Name | sphinxcontrib-jquery JSON |
| Version |
4.1
JSON |
| download |
| home_page | |
| Summary | Extension to include jQuery on newer Sphinx releases |
| upload_time | 2023-03-14 15:01:01 |
| maintainer | |
| docs_url | None |
| author | Adam Turner |
| requires_python | >=2.7 |
| license | |
| keywords |
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
======================
sphinxcontrib-jquery
======================
.. image:: https://img.shields.io/pypi/v/sphinxcontrib-jquery.svg
:target: https://pypi.org/project/sphinxcontrib-jquery/
:alt: Package on PyPI
``sphinxcontrib-jquery`` ensures that jQuery is always installed for use in
Sphinx themes or extensions.
To use it, add ``sphinxcontrib.jquery`` as a Sphinx extension:
.. code:: python
# conf.py
extensions = [
"sphinxcontrib.jquery",
]
...
Configuration
-------------
.. As this is a README, we restrict the directives we use to those which GitHub
renders correctly. This means that we cannot use ``versionadded``,
``confval``, ``warning``, or other similar directives.
We use a reStructuredText definition list to emulate the ``confval``
rendering.
We use inline **bold** syntax as a poor-man's ``.. warning::`` directive.
``jquery_use_sri``
A boolean value controlling whether to enable `subresource integrity`_ (SRI)
checks for JavaScript files that this extension loads.
The default is ``False``.
**Warning**: Enabling SRI checks may break documentation when loaded from
local filesystem (``file:///`` URIs).
*New in version 4.0.*
.. _subresource integrity: https://developer.mozilla.org/en-US/docs/Web/Security/Subresource_Integrity
Raw data
{
"_id": null,
"home_page": "",
"name": "sphinxcontrib-jquery",
"maintainer": "",
"docs_url": null,
"requires_python": ">=2.7",
"maintainer_email": "",
"keywords": "",
"author": "Adam Turner",
"author_email": "",
"download_url": "https://files.pythonhosted.org/packages/de/f3/aa67467e051df70a6330fe7770894b3e4f09436dea6881ae0b4f3d87cad8/sphinxcontrib-jquery-4.1.tar.gz",
"platform": null,
"description": "======================\n sphinxcontrib-jquery\n======================\n\n.. image:: https://img.shields.io/pypi/v/sphinxcontrib-jquery.svg\n :target: https://pypi.org/project/sphinxcontrib-jquery/\n :alt: Package on PyPI\n\n``sphinxcontrib-jquery`` ensures that jQuery is always installed for use in\nSphinx themes or extensions.\n\nTo use it, add ``sphinxcontrib.jquery`` as a Sphinx extension:\n\n.. code:: python\n\n # conf.py\n\n extensions = [\n \"sphinxcontrib.jquery\",\n ]\n ...\n\n\nConfiguration\n-------------\n\n.. As this is a README, we restrict the directives we use to those which GitHub\n renders correctly. This means that we cannot use ``versionadded``,\n ``confval``, ``warning``, or other similar directives.\n We use a reStructuredText definition list to emulate the ``confval``\n rendering.\n We use inline **bold** syntax as a poor-man's ``.. warning::`` directive.\n\n``jquery_use_sri``\n A boolean value controlling whether to enable `subresource integrity`_ (SRI)\n checks for JavaScript files that this extension loads.\n\n The default is ``False``.\n\n **Warning**: Enabling SRI checks may break documentation when loaded from\n local filesystem (``file:///`` URIs).\n\n *New in version 4.0.*\n\n .. _subresource integrity: https://developer.mozilla.org/en-US/docs/Web/Security/Subresource_Integrity\n\n",
"bugtrack_url": null,
"license": "",
"summary": "Extension to include jQuery on newer Sphinx releases",
"version": "4.1",
"project_urls": {
"Repository": "https://github.com/sphinx-contrib/jquery/"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "7685749bd22d1a68db7291c89e2ebca53f4306c3f205853cf31e9de279034c3c",
"md5": "b08aad7e32bbfaa3a962da5b2a0f8481",
"sha256": "f936030d7d0147dd026a4f2b5a57343d233f1fc7b363f68b3d4f1cb0993878ae"
},
"downloads": -1,
"filename": "sphinxcontrib_jquery-4.1-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "b08aad7e32bbfaa3a962da5b2a0f8481",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": ">=2.7",
"size": 121104,
"upload_time": "2023-03-14T15:01:00",
"upload_time_iso_8601": "2023-03-14T15:01:00.356566Z",
"url": "https://files.pythonhosted.org/packages/76/85/749bd22d1a68db7291c89e2ebca53f4306c3f205853cf31e9de279034c3c/sphinxcontrib_jquery-4.1-py2.py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "def3aa67467e051df70a6330fe7770894b3e4f09436dea6881ae0b4f3d87cad8",
"md5": "46ea52845b17343ed6c61e6963fb265d",
"sha256": "1620739f04e36a2c779f1a131a2dfd49b2fd07351bf1968ced074365933abc7a"
},
"downloads": -1,
"filename": "sphinxcontrib-jquery-4.1.tar.gz",
"has_sig": false,
"md5_digest": "46ea52845b17343ed6c61e6963fb265d",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=2.7",
"size": 122331,
"upload_time": "2023-03-14T15:01:01",
"upload_time_iso_8601": "2023-03-14T15:01:01.944181Z",
"url": "https://files.pythonhosted.org/packages/de/f3/aa67467e051df70a6330fe7770894b3e4f09436dea6881ae0b4f3d87cad8/sphinxcontrib-jquery-4.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-03-14 15:01:01",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "sphinx-contrib",
"github_project": "jquery",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "sphinxcontrib-jquery"
}
