sphinxcontrib-lightbox2
Sphinx extension to add lightbox2 to each figure and image added in HTML.
Read the documentation on ReadTheDocs!
Usually Sphinx themes limit their content width to a limit to improve readability. This creates a problem for large images and diagrams which might be needed in technical documentation.
Installation
Install the package using
pip install sphinxcontrib-lightbox2
Add sphinxcontrib.lightbox2 to the list of extensions in your conf.py:
extensions = ["sphinxcontrib.lightbox2"]
Configuration
Lightbox2 offers different configuration options.
These options are exposed in sphinxcontrib-lightbox2 through options in the conf.py.
See the mapping of lightbox2 options to Sphinx options
| Lightbox2 Option Name | Sphinx Option Name | Default Value |
|---|---|---|
alwaysShowNavOnTouchDevices |
lightbox2_always_show_nav_on_touch_devices |
False |
albumLabel |
lightbox2_album_label |
"Image %1 of %2" |
disableScrolling |
lightbox2_disable_scrolling |
False |
fadeDuration |
lightbox2_fade_duration |
600 |
fitImagesInViewport |
lightbox2_fit_images_in_viewport |
True |
imageFadeDuration |
lightbox2_image_fade_duration |
600 |
maxWidth |
lightbox2_max_width |
None |
maxHeight |
lightbox2_max_height |
None |
positionFromTop |
lightbox2_position_from_top |
50 |
resizeDuration |
lightbox2_resize_duration |
700 |
showImageNumberLabel |
lightbox2_show_image_number_label |
True |
wrapAround |
lightbox2_wrap_around |
True |
Examples
See the examples in the documentation.
1 maintainer
Metadata
1 maintainer
Release files for sphinxcontrib-lightbox2 0.6.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| sphinxcontrib_lightbox2-0.6.0.tar.gz | 112.1 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| sphinxcontrib_lightbox2-0.6.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 224.9 kB
Release files / sphinxcontrib_lightbox2-0.6.0.tar.gz
| Download URL | sphinxcontrib_lightbox2-0.6.0.tar.gz |
|---|---|
| Size | 112.1 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
aeda9d982dbbebc88c36e5a00aa41c2ade6d017affb827e68712a7ede08bea29
|
|
BLAKE2b-256 checksum How to use checksums |
b8fff6decb9f9a6a6da4d1ece9b0a4db51d0d8b010f93957c44ff57ed5bba35c
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
uv/0.11.1 {"installer":{"name":"uv","version":"0.11.1","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}
|
Release files / sphinxcontrib_lightbox2-0.6.0-py3-none-any.whl
| Download URL | sphinxcontrib_lightbox2-0.6.0-py3-none-any.whl |
|---|---|
| Size | 112.9 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
7dd194b442ba45d3cf694f625320c1d2602bdaeefb52d173b2767747fd901080
|
|
BLAKE2b-256 checksum How to use checksums |
f87b941cb0508d0e583d994b3c1b2fdc1263eccd8dae40fc5529a9d16a025c4a
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
uv/0.11.1 {"installer":{"name":"uv","version":"0.11.1","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}
|
