=====================
sphinx-jinja2-compat
=====================
.. start short_desc
**Patches Jinja2 v3 to restore compatibility with earlier Sphinx versions.**
.. end short_desc
Also makes some Sphinx versions work correctly on Python 3.10.
The patches can be disabled by setting the environment variable ``NO_SPHINX_JINJA2_COMPAT`` to ``1``. (v0.2.0 and newer only)
.. start shields
.. list-table::
:stub-columns: 1
:widths: 10 90
* - Tests
- |actions_linux| |actions_windows| |actions_macos|
* - PyPI
- |pypi-version| |supported-versions| |supported-implementations| |wheel|
* - Anaconda
- |conda-version| |conda-platform|
* - Activity
- |commits-latest| |commits-since| |maintained| |pypi-downloads|
* - QA
- |codefactor| |actions_flake8| |actions_mypy|
* - Other
- |license| |language| |requires|
.. |actions_linux| image:: https://github.com/sphinx-toolbox/sphinx-jinja2-compat/workflows/Linux/badge.svg
:target: https://github.com/sphinx-toolbox/sphinx-jinja2-compat/actions?query=workflow%3A%22Linux%22
:alt: Linux Test Status
.. |actions_windows| image:: https://github.com/sphinx-toolbox/sphinx-jinja2-compat/workflows/Windows/badge.svg
:target: https://github.com/sphinx-toolbox/sphinx-jinja2-compat/actions?query=workflow%3A%22Windows%22
:alt: Windows Test Status
.. |actions_macos| image:: https://github.com/sphinx-toolbox/sphinx-jinja2-compat/workflows/macOS/badge.svg
:target: https://github.com/sphinx-toolbox/sphinx-jinja2-compat/actions?query=workflow%3A%22macOS%22
:alt: macOS Test Status
.. |actions_flake8| image:: https://github.com/sphinx-toolbox/sphinx-jinja2-compat/workflows/Flake8/badge.svg
:target: https://github.com/sphinx-toolbox/sphinx-jinja2-compat/actions?query=workflow%3A%22Flake8%22
:alt: Flake8 Status
.. |actions_mypy| image:: https://github.com/sphinx-toolbox/sphinx-jinja2-compat/workflows/mypy/badge.svg
:target: https://github.com/sphinx-toolbox/sphinx-jinja2-compat/actions?query=workflow%3A%22mypy%22
:alt: mypy status
.. |requires| image:: https://dependency-dash.repo-helper.uk/github/sphinx-toolbox/sphinx-jinja2-compat/badge.svg
:target: https://dependency-dash.repo-helper.uk/github/sphinx-toolbox/sphinx-jinja2-compat/
:alt: Requirements Status
.. |codefactor| image:: https://img.shields.io/codefactor/grade/github/sphinx-toolbox/sphinx-jinja2-compat?logo=codefactor
:target: https://www.codefactor.io/repository/github/sphinx-toolbox/sphinx-jinja2-compat
:alt: CodeFactor Grade
.. |pypi-version| image:: https://img.shields.io/pypi/v/sphinx-jinja2-compat
:target: https://pypi.org/project/sphinx-jinja2-compat/
:alt: PyPI - Package Version
.. |supported-versions| image:: https://img.shields.io/pypi/pyversions/sphinx-jinja2-compat?logo=python&logoColor=white
:target: https://pypi.org/project/sphinx-jinja2-compat/
:alt: PyPI - Supported Python Versions
.. |supported-implementations| image:: https://img.shields.io/pypi/implementation/sphinx-jinja2-compat
:target: https://pypi.org/project/sphinx-jinja2-compat/
:alt: PyPI - Supported Implementations
.. |wheel| image:: https://img.shields.io/pypi/wheel/sphinx-jinja2-compat
:target: https://pypi.org/project/sphinx-jinja2-compat/
:alt: PyPI - Wheel
.. |conda-version| image:: https://img.shields.io/conda/v/domdfcoding/sphinx-jinja2-compat?logo=anaconda
:target: https://anaconda.org/domdfcoding/sphinx-jinja2-compat
:alt: Conda - Package Version
.. |conda-platform| image:: https://img.shields.io/conda/pn/domdfcoding/sphinx-jinja2-compat?label=conda%7Cplatform
:target: https://anaconda.org/domdfcoding/sphinx-jinja2-compat
:alt: Conda - Platform
.. |license| image:: https://img.shields.io/github/license/sphinx-toolbox/sphinx-jinja2-compat
:target: https://github.com/sphinx-toolbox/sphinx-jinja2-compat/blob/master/LICENSE
:alt: License
.. |language| image:: https://img.shields.io/github/languages/top/sphinx-toolbox/sphinx-jinja2-compat
:alt: GitHub top language
.. |commits-since| image:: https://img.shields.io/github/commits-since/sphinx-toolbox/sphinx-jinja2-compat/v0.3.0
:target: https://github.com/sphinx-toolbox/sphinx-jinja2-compat/pulse
:alt: GitHub commits since tagged version
.. |commits-latest| image:: https://img.shields.io/github/last-commit/sphinx-toolbox/sphinx-jinja2-compat
:target: https://github.com/sphinx-toolbox/sphinx-jinja2-compat/commit/master
:alt: GitHub last commit
.. |maintained| image:: https://img.shields.io/maintenance/yes/2024
:alt: Maintenance
.. |pypi-downloads| image:: https://img.shields.io/pypi/dm/sphinx-jinja2-compat
:target: https://pypi.org/project/sphinx-jinja2-compat/
:alt: PyPI - Downloads
.. end shields
Installation
--------------
.. start installation
``sphinx-jinja2-compat`` can be installed from PyPI or Anaconda.
To install with ``pip``:
.. code-block:: bash
$ python -m pip install sphinx-jinja2-compat
To install with ``conda``:
* First add the required channels
.. code-block:: bash
$ conda config --add channels https://conda.anaconda.org/conda-forge
$ conda config --add channels https://conda.anaconda.org/domdfcoding
* Then install
.. code-block:: bash
$ conda install sphinx-jinja2-compat
.. end installation
Raw data
{
"_id": null,
"home_page": "https://github.com/sphinx-toolbox/sphinx-jinja2-compat",
"name": "sphinx-jinja2-compat",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": null,
"keywords": "documentation, jinja2, sphinx",
"author": null,
"author_email": "Dominic Davis-Foster <dominic@davis-foster.co.uk>",
"download_url": "https://files.pythonhosted.org/packages/26/df/27282da6f8c549f765beca9de1a5fc56f9651ed87711a5cac1e914137753/sphinx_jinja2_compat-0.3.0.tar.gz",
"platform": "Windows",
"description": "\n=====================\nsphinx-jinja2-compat\n=====================\n\n.. start short_desc\n\n**Patches Jinja2 v3 to restore compatibility with earlier Sphinx versions.**\n\n.. end short_desc\n\nAlso makes some Sphinx versions work correctly on Python 3.10.\n\nThe patches can be disabled by setting the environment variable ``NO_SPHINX_JINJA2_COMPAT`` to ``1``. (v0.2.0 and newer only)\n\n\n.. start shields\n\n.. list-table::\n\t:stub-columns: 1\n\t:widths: 10 90\n\n\t* - Tests\n\t - |actions_linux| |actions_windows| |actions_macos|\n\t* - PyPI\n\t - |pypi-version| |supported-versions| |supported-implementations| |wheel|\n\t* - Anaconda\n\t - |conda-version| |conda-platform|\n\t* - Activity\n\t - |commits-latest| |commits-since| |maintained| |pypi-downloads|\n\t* - QA\n\t - |codefactor| |actions_flake8| |actions_mypy|\n\t* - Other\n\t - |license| |language| |requires|\n\n.. |actions_linux| image:: https://github.com/sphinx-toolbox/sphinx-jinja2-compat/workflows/Linux/badge.svg\n\t:target: https://github.com/sphinx-toolbox/sphinx-jinja2-compat/actions?query=workflow%3A%22Linux%22\n\t:alt: Linux Test Status\n\n.. |actions_windows| image:: https://github.com/sphinx-toolbox/sphinx-jinja2-compat/workflows/Windows/badge.svg\n\t:target: https://github.com/sphinx-toolbox/sphinx-jinja2-compat/actions?query=workflow%3A%22Windows%22\n\t:alt: Windows Test Status\n\n.. |actions_macos| image:: https://github.com/sphinx-toolbox/sphinx-jinja2-compat/workflows/macOS/badge.svg\n\t:target: https://github.com/sphinx-toolbox/sphinx-jinja2-compat/actions?query=workflow%3A%22macOS%22\n\t:alt: macOS Test Status\n\n.. |actions_flake8| image:: https://github.com/sphinx-toolbox/sphinx-jinja2-compat/workflows/Flake8/badge.svg\n\t:target: https://github.com/sphinx-toolbox/sphinx-jinja2-compat/actions?query=workflow%3A%22Flake8%22\n\t:alt: Flake8 Status\n\n.. |actions_mypy| image:: https://github.com/sphinx-toolbox/sphinx-jinja2-compat/workflows/mypy/badge.svg\n\t:target: https://github.com/sphinx-toolbox/sphinx-jinja2-compat/actions?query=workflow%3A%22mypy%22\n\t:alt: mypy status\n\n.. |requires| image:: https://dependency-dash.repo-helper.uk/github/sphinx-toolbox/sphinx-jinja2-compat/badge.svg\n\t:target: https://dependency-dash.repo-helper.uk/github/sphinx-toolbox/sphinx-jinja2-compat/\n\t:alt: Requirements Status\n\n.. |codefactor| image:: https://img.shields.io/codefactor/grade/github/sphinx-toolbox/sphinx-jinja2-compat?logo=codefactor\n\t:target: https://www.codefactor.io/repository/github/sphinx-toolbox/sphinx-jinja2-compat\n\t:alt: CodeFactor Grade\n\n.. |pypi-version| image:: https://img.shields.io/pypi/v/sphinx-jinja2-compat\n\t:target: https://pypi.org/project/sphinx-jinja2-compat/\n\t:alt: PyPI - Package Version\n\n.. |supported-versions| image:: https://img.shields.io/pypi/pyversions/sphinx-jinja2-compat?logo=python&logoColor=white\n\t:target: https://pypi.org/project/sphinx-jinja2-compat/\n\t:alt: PyPI - Supported Python Versions\n\n.. |supported-implementations| image:: https://img.shields.io/pypi/implementation/sphinx-jinja2-compat\n\t:target: https://pypi.org/project/sphinx-jinja2-compat/\n\t:alt: PyPI - Supported Implementations\n\n.. |wheel| image:: https://img.shields.io/pypi/wheel/sphinx-jinja2-compat\n\t:target: https://pypi.org/project/sphinx-jinja2-compat/\n\t:alt: PyPI - Wheel\n\n.. |conda-version| image:: https://img.shields.io/conda/v/domdfcoding/sphinx-jinja2-compat?logo=anaconda\n\t:target: https://anaconda.org/domdfcoding/sphinx-jinja2-compat\n\t:alt: Conda - Package Version\n\n.. |conda-platform| image:: https://img.shields.io/conda/pn/domdfcoding/sphinx-jinja2-compat?label=conda%7Cplatform\n\t:target: https://anaconda.org/domdfcoding/sphinx-jinja2-compat\n\t:alt: Conda - Platform\n\n.. |license| image:: https://img.shields.io/github/license/sphinx-toolbox/sphinx-jinja2-compat\n\t:target: https://github.com/sphinx-toolbox/sphinx-jinja2-compat/blob/master/LICENSE\n\t:alt: License\n\n.. |language| image:: https://img.shields.io/github/languages/top/sphinx-toolbox/sphinx-jinja2-compat\n\t:alt: GitHub top language\n\n.. |commits-since| image:: https://img.shields.io/github/commits-since/sphinx-toolbox/sphinx-jinja2-compat/v0.3.0\n\t:target: https://github.com/sphinx-toolbox/sphinx-jinja2-compat/pulse\n\t:alt: GitHub commits since tagged version\n\n.. |commits-latest| image:: https://img.shields.io/github/last-commit/sphinx-toolbox/sphinx-jinja2-compat\n\t:target: https://github.com/sphinx-toolbox/sphinx-jinja2-compat/commit/master\n\t:alt: GitHub last commit\n\n.. |maintained| image:: https://img.shields.io/maintenance/yes/2024\n\t:alt: Maintenance\n\n.. |pypi-downloads| image:: https://img.shields.io/pypi/dm/sphinx-jinja2-compat\n\t:target: https://pypi.org/project/sphinx-jinja2-compat/\n\t:alt: PyPI - Downloads\n\n.. end shields\n\nInstallation\n--------------\n\n.. start installation\n\n``sphinx-jinja2-compat`` can be installed from PyPI or Anaconda.\n\nTo install with ``pip``:\n\n.. code-block:: bash\n\n\t$ python -m pip install sphinx-jinja2-compat\n\nTo install with ``conda``:\n\n\t* First add the required channels\n\n\t.. code-block:: bash\n\n\t\t$ conda config --add channels https://conda.anaconda.org/conda-forge\n\t\t$ conda config --add channels https://conda.anaconda.org/domdfcoding\n\n\t* Then install\n\n\t.. code-block:: bash\n\n\t\t$ conda install sphinx-jinja2-compat\n\n.. end installation\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Patches Jinja2 v3 to restore compatibility with earlier Sphinx versions.",
"version": "0.3.0",
"project_urls": {
"Homepage": "https://github.com/sphinx-toolbox/sphinx-jinja2-compat",
"Issue Tracker": "https://github.com/sphinx-toolbox/sphinx-jinja2-compat/issues",
"Source Code": "https://github.com/sphinx-toolbox/sphinx-jinja2-compat"
},
"split_keywords": [
"documentation",
" jinja2",
" sphinx"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "6f422fd09d672eaaa937d6893d8b747d07943f97a6e5e30653aee6ebd339b704",
"md5": "20e10007c4a1935701a122747995541b",
"sha256": "b1e4006d8e1ea31013fa9946d1b075b0c8d2a42c6e3425e63542c1e9f8be9084"
},
"downloads": -1,
"filename": "sphinx_jinja2_compat-0.3.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "20e10007c4a1935701a122747995541b",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6",
"size": 7883,
"upload_time": "2024-06-19T10:26:59",
"upload_time_iso_8601": "2024-06-19T10:26:59.121972Z",
"url": "https://files.pythonhosted.org/packages/6f/42/2fd09d672eaaa937d6893d8b747d07943f97a6e5e30653aee6ebd339b704/sphinx_jinja2_compat-0.3.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "26df27282da6f8c549f765beca9de1a5fc56f9651ed87711a5cac1e914137753",
"md5": "7834135e0a6eb6b3e8db7b8ef38cca10",
"sha256": "f3c1590b275f42e7a654e081db5e3e5fb97f515608422bde94015ddf795dfe7c"
},
"downloads": -1,
"filename": "sphinx_jinja2_compat-0.3.0.tar.gz",
"has_sig": false,
"md5_digest": "7834135e0a6eb6b3e8db7b8ef38cca10",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 4998,
"upload_time": "2024-06-19T10:27:00",
"upload_time_iso_8601": "2024-06-19T10:27:00.781089Z",
"url": "https://files.pythonhosted.org/packages/26/df/27282da6f8c549f765beca9de1a5fc56f9651ed87711a5cac1e914137753/sphinx_jinja2_compat-0.3.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-06-19 10:27:00",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "sphinx-toolbox",
"github_project": "sphinx-jinja2-compat",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [
{
"name": "jinja2",
"specs": [
[
">=",
"2.10"
]
]
},
{
"name": "markupsafe",
"specs": [
[
">=",
"1"
]
]
},
{
"name": "standard-imghdr",
"specs": [
[
"==",
"3.10.14"
]
]
}
],
"tox": true,
"lcname": "sphinx-jinja2-compat"
}
JSON
