{"id":25492373,"url":"https://github.com/jonasehrlich/sphinxcontrib-lightbox2","last_synced_at":"2025-04-10T00:16:16.345Z","repository":{"id":238169846,"uuid":"796020133","full_name":"jonasehrlich/sphinxcontrib-lightbox2","owner":"jonasehrlich","description":"Sphinx extension to add lightbox2 to image added in HTML.","archived":false,"fork":false,"pushed_at":"2024-09-19T20:50:08.000Z","size":254,"stargazers_count":2,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-04-10T00:16:12.329Z","etag":null,"topics":["lightbox2","sphinx","sphinxcontrib"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/jonasehrlich.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-05-04T17:35:31.000Z","updated_at":"2025-03-08T12:50:43.000Z","dependencies_parsed_at":"2025-02-18T22:31:27.658Z","dependency_job_id":"cb029c94-1e5c-4dd9-9ab6-0bc8f9a71f8c","html_url":"https://github.com/jonasehrlich/sphinxcontrib-lightbox2","commit_stats":null,"previous_names":["jonasehrlich/sphinxcontrib-lightbox2"],"tags_count":5,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jonasehrlich%2Fsphinxcontrib-lightbox2","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jonasehrlich%2Fsphinxcontrib-lightbox2/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jonasehrlich%2Fsphinxcontrib-lightbox2/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jonasehrlich%2Fsphinxcontrib-lightbox2/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/jonasehrlich","download_url":"https://codeload.github.com/jonasehrlich/sphinxcontrib-lightbox2/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248131315,"owners_count":21052819,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["lightbox2","sphinx","sphinxcontrib"],"created_at":"2025-02-18T22:29:36.493Z","updated_at":"2025-04-10T00:16:16.319Z","avatar_url":"https://github.com/jonasehrlich.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# sphinxcontrib-lightbox2\n\nSphinx extension to add [lightbox2](https://lokeshdhakar.com/projects/lightbox2/) to each figure and image added in HTML.\n\n---\n\n**[Read the documentation on ReadTheDocs!](https://sphinxcontrib-lightbox2.readthedocs.io/)**\n\n---\n\nUsually Sphinx themes limit their content width to a limit to improve readability. This creates a problem for large\nimages and diagrams which might be needed in technical documentation.\n\n## Installation\n\nInstall the package using\n\n```sh\npip install sphinxcontrib-lightbox2\n```\n\nAdd `sphinxcontrib.lightbox2` to the list of `extensions` in your *conf.py*:\n\n``` python\nextensions = [\"sphinxcontrib.lightbox2\"]\n```\n\n## Configuration\n\nLightbox2 offers different configuration [options](https://lokeshdhakar.com/projects/lightbox2/#options).\nThese options are exposed in `sphinxcontrib-lightbox2` through options in the *conf.py*.\n\nSee the mapping of lightbox2 options to Sphinx options\n\n| Lightbox2 Option Name | Sphinx Option Name | Default Value |\n| ----------------------|--------------------|---------------|\n| `alwaysShowNavOnTouchDevices` | `lightbox2_always_show_nav_on_touch_devices` | `False` |\n| `albumLabel` | `lightbox2_album_label` | `\"Image %1 of %2\"` |\n| `disableScrolling` | `lightbox2_disable_scrolling`| `False` |\n| `fadeDuration` | `lightbox2_fade_duration`| `600` |\n| `fitImagesInViewport` | `lightbox2_fit_images_in_viewport`| `True` |\n| `imageFadeDuration` | `lightbox2_image_fade_duration`| `600` |\n| `maxWidth` | `lightbox2_max_width`| `None` |\n| `maxHeight` | `lightbox2_max_height`| `None` |\n| `positionFromTop` | `lightbox2_position_from_top`| `50` |\n| `resizeDuration` | `lightbox2_resize_duration`| `700` |\n| `showImageNumberLabel` | `lightbox2_show_image_number_label`| `True` |\n| `wrapAround` | `lightbox2_wrap_around`| `True` |\n\n\u003c!-- README is only included in documentation until here --\u003e\n\n## Examples\n\nSee the examples in the [documentation](https://sphinxcontrib-lightbox2.readthedocs.io/#examples).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjonasehrlich%2Fsphinxcontrib-lightbox2","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjonasehrlich%2Fsphinxcontrib-lightbox2","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjonasehrlich%2Fsphinxcontrib-lightbox2/lists"}