sphinxext-photofinish
Advanced tools
Photofinish is a sphinx extension for creating responsive images to your Sphinx site. This has several benefits:
Photofinish can dramatically increase the loading time of your Sphinx website.
python -m pip install sphinxext-photofinish
Just add sphinxext-photofinish to your extensions list in your conf.py
extensions = [
"sphinxext.photofinish",
]
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.
FAQs
Sphinx Extension that creates responsive images.
We found that sphinxext-photofinish demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Research
The Socket Research Team breaks down a malicious wrapper package that uses obfuscation to harvest credentials and exfiltrate sensitive data.
Research
Security News
Attackers used a malicious npm package typosquatting a popular ESLint plugin to steal sensitive data, execute commands, and exploit developer systems.
Security News
The Ultralytics' PyPI Package was compromised four times in one weekend through GitHub Actions cache poisoning and failure to rotate previously compromised API tokens.