sphinxext-photofinish
Photofinish is a sphinx extension for creating responsive images to your Sphinx site. This has several benefits:
- Lower bandwidth cost for browsers and devices that don't need the higher resolution version
- Higher resolution images for higher resolution devices
Photofinish can dramatically increase the loading time of your Sphinx website.
Installation
python -m pip install sphinxext-photofinish
Usage
Just add sphinxext-photofinish to your extensions list in your conf.py
extensions = [
"sphinxext.photofinish",
]
Configuration
Photofinish adds several conf.py options that you can optionally configure:
max_viewport_width - This is maximum "viewable" size of images in your documentation. Typically, it's set to the width of your body. Responsive images are generated up to double of this value. Default is 1000.
width_min - Minimum width of images to generate. Default is 500.
width_step - The resolution to iterate over for generating images. EX: 500, 800, 1100. Default is 300.
photofinish_ci_only - Should this extension only run if the CI environment variable is set? Default is False.
1 maintainer
Metadata
1 maintainer
Release files for sphinxext-photofinish 0.1.13
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| sphinxext_photofinish-0.1.13.tar.gz | 12.6 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| sphinxext_photofinish-0.1.13-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 24.7 kB
Release files / sphinxext_photofinish-0.1.13.tar.gz
| Download URL | sphinxext_photofinish-0.1.13.tar.gz |
|---|---|
| Size | 12.6 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
dd67df3e0745602d90f8448f4fa743ec15fb2f80033ba9636fc88afb847d545e
|
|
BLAKE2b-256 checksum How to use checksums |
28591da6e2181d931a805ebe5a3910a3a0a88d755e3bf59ba66ea5ef7e1f38f7
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Release files / sphinxext_photofinish-0.1.13-py3-none-any.whl
| Download URL | sphinxext_photofinish-0.1.13-py3-none-any.whl |
|---|---|
| Size | 12.1 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
c5d15878f65b65035113d4a2225e30696e4c79794b17dfba7ef7d66e9ec06324
|
|
BLAKE2b-256 checksum How to use checksums |
a4e36333c7bd5131a38455aff6bc650d14526a4efb1d5ce9dc0eaec269867f1f
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
