sphinxcontrib-images
====================
sphinxcontrib-images (formerly `sphinxcontrib-fancybox
<https://pypi.python.org/pypi/sphinxcontrib-fancybox>`_).
Easy thumbnails in Sphinx documentation (focused on HTML).
* `Documentation <https://sphinxcontrib-images.readthedocs.io>`_
* `Repository (GitHub) <https://github.com/sphinx-contrib/images/>`_
* `PyPI <https://pypi.python.org/pypi/sphinxcontrib-images/>`_
* `GitHub actions <https://github.com/sphinx-contrib/images/actions/workflows/ci.yml>`_
.. image:: https://github.com/sphinx-contrib/images/actions/workflows/ci.yml/badge.svg
:target: https://github.com/sphinx-contrib/images/actions/workflows/ci.yml
:alt: GitHub Actions
Features
--------
* Show thumbnails instead of full size images inside documentation (HTML).
* Ability to zoom/enlarge picture using LightBox2 (HTML).
* Ability to group pictures
* Download remote pictures and keep it in cache (if requested)
* Support for other formats (latex, epub, ... - fallback to image directive)
* Easy to extend (add own backend in only few lines of code)
* Add other HTML "preview" solution than LightBox2
* Add better support to non-HTML outputs
* Preprocess images
TODO
^^^^
* Make proper thumbnails (scale down images)
How to install?
---------------
Instalation through pip: ::
pip install sphinxcontrib-images
or through the GitHub: ::
pip install git+https://github.com/sphinx-contrib/images
Next, you have to add extension to ``conf.py`` in your Sphinx project. ::
extensions = [
…
'sphinxcontrib.images',
…
]
How to use it?
--------------
Example: ::
.. thumbnail:: picture.png
You can also override the default ``image`` directive provided by Sphinx.
Check the documentation for all configuration options.
Questions and suggestions
-------------------------
If you have any suggstions, patches, problems - please use
`GitHub Issues <https://github.com/sphinx-contrib/images/issues>`_.
Raw data
{
"_id": null,
"home_page": "https://github.com/sphinx-contrib/images",
"name": "sphinxcontrib-images",
"maintainer": "",
"docs_url": "https://pythonhosted.org/sphinxcontrib-images/",
"requires_python": "",
"maintainer_email": "",
"keywords": "",
"author": "Tomasz Czy\u017c",
"author_email": "tomasz.czyz@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/63/52/f0f6bcaa59231d8ac1efc8f6e92c9e14004bab2b420cefe3fcd60c082d0b/sphinxcontrib-images-0.9.4.tar.gz",
"platform": "any",
"description": "sphinxcontrib-images\n====================\n\nsphinxcontrib-images (formerly `sphinxcontrib-fancybox\n<https://pypi.python.org/pypi/sphinxcontrib-fancybox>`_).\n\nEasy thumbnails in Sphinx documentation (focused on HTML).\n\n* `Documentation <https://sphinxcontrib-images.readthedocs.io>`_\n* `Repository (GitHub) <https://github.com/sphinx-contrib/images/>`_\n* `PyPI <https://pypi.python.org/pypi/sphinxcontrib-images/>`_\n* `GitHub actions <https://github.com/sphinx-contrib/images/actions/workflows/ci.yml>`_\n\n .. image:: https://github.com/sphinx-contrib/images/actions/workflows/ci.yml/badge.svg\n :target: https://github.com/sphinx-contrib/images/actions/workflows/ci.yml\n :alt: GitHub Actions\n\nFeatures\n--------\n\n* Show thumbnails instead of full size images inside documentation (HTML).\n* Ability to zoom/enlarge picture using LightBox2 (HTML).\n* Ability to group pictures\n* Download remote pictures and keep it in cache (if requested)\n* Support for other formats (latex, epub, ... - fallback to image directive)\n* Easy to extend (add own backend in only few lines of code)\n\n * Add other HTML \"preview\" solution than LightBox2\n * Add better support to non-HTML outputs\n * Preprocess images\n\nTODO\n^^^^\n\n* Make proper thumbnails (scale down images)\n\nHow to install?\n---------------\n\nInstalation through pip: ::\n\n pip install sphinxcontrib-images\n\nor through the GitHub: ::\n\n pip install git+https://github.com/sphinx-contrib/images\n\nNext, you have to add extension to ``conf.py`` in your Sphinx project. ::\n\n extensions = [\n \u2026\n 'sphinxcontrib.images',\n \u2026\n ]\n\n\nHow to use it?\n--------------\n\nExample: ::\n\n .. thumbnail:: picture.png\n\n\nYou can also override the default ``image`` directive provided by Sphinx.\nCheck the documentation for all configuration options.\n\n\nQuestions and suggestions\n-------------------------\n\nIf you have any suggstions, patches, problems - please use\n`GitHub Issues <https://github.com/sphinx-contrib/images/issues>`_.\n\n\n",
"bugtrack_url": null,
"license": "Apache 2",
"summary": "Sphinx extension for thumbnails",
"version": "0.9.4",
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "7163ca2260e431b94cf9fe073c12d363a4981b94483e08fb3962089047248540",
"md5": "a9e19c1a7097eb338f2794d4adbb61b9",
"sha256": "8863e8e8533a116f45cb92523938ab25879cc31dc594f5de4c3dbd9ab3d440b0"
},
"downloads": -1,
"filename": "sphinxcontrib_images-0.9.4-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "a9e19c1a7097eb338f2794d4adbb61b9",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": null,
"size": 118717,
"upload_time": "2021-08-09T04:53:46",
"upload_time_iso_8601": "2021-08-09T04:53:46.435820Z",
"url": "https://files.pythonhosted.org/packages/71/63/ca2260e431b94cf9fe073c12d363a4981b94483e08fb3962089047248540/sphinxcontrib_images-0.9.4-py2.py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "6352f0f6bcaa59231d8ac1efc8f6e92c9e14004bab2b420cefe3fcd60c082d0b",
"md5": "2842c3609542b14976c6ceabb658d504",
"sha256": "f6c237d0430793e65d91dbddb13b1fb26a2cf838040a9deeb52112969fbc4a4b"
},
"downloads": -1,
"filename": "sphinxcontrib-images-0.9.4.tar.gz",
"has_sig": false,
"md5_digest": "2842c3609542b14976c6ceabb658d504",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 116949,
"upload_time": "2021-08-09T04:53:49",
"upload_time_iso_8601": "2021-08-09T04:53:49.104587Z",
"url": "https://files.pythonhosted.org/packages/63/52/f0f6bcaa59231d8ac1efc8f6e92c9e14004bab2b420cefe3fcd60c082d0b/sphinxcontrib-images-0.9.4.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2021-08-09 04:53:49",
"github": true,
"gitlab": false,
"bitbucket": false,
"github_user": "sphinx-contrib",
"github_project": "images",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"tox": true,
"lcname": "sphinxcontrib-images"
}