{"categories":[{"label":"Sphinx","url":"https://skillfed.io/packages/category/documentation-sphinx"}],"enrichment":{"capability":"Sphinx-Gallery is a Sphinx extension that automatically generates HTML galleries of executable examples from Python scripts, extracting outputs and embedding them into your documentation.","skillfed_tags":["documentation-generation","sphinx-extension","example-gallery"],"use_cases":["Build an interactive example gallery for a scientific Python library (like scikit-learn or Matplotlib) to demonstrate typical usage patterns.","Generate a gallery of tutorials or how-to guides from executable Python scripts as part of your project documentation.","Showcase data analysis workflows or computational examples with live output and visualizations in a web-accessible format.","Create a portfolio or cookbook of example code snippets with their results for educational or reference purposes.","Automatically keep example outputs in sync with code changes by re-executing scripts during documentation builds."],"what_it_does":"Sphinx-Gallery is a Sphinx extension that transforms a directory of Python example scripts into an interactive HTML gallery embedded in your documentation. It executes each script, captures outputs (including plots from Matplotlib and related packages), and generates formatted gallery pages with the code, results, and narrative text from docstrings or accompanying README files.\n\nYou configure it in your Sphinx conf.py by specifying the source directory of example scripts and the output directory for generated gallery files. Sphinx-Gallery then handles execution, output capture, and reST file generation during your normal Sphinx build. It's designed for library documentation but can also serve as a standalone showcase for a Python package or module.","worth_installing":"Yes. Sphinx-Gallery is a mature, actively maintained tool with low install friction and no known vulnerabilities. It solves a concrete problem\u2014turning Python scripts into documented, executable galleries\u2014and is widely adopted by major projects. Install it if you need to showcase runnable examples in Sphinx documentation."},"id":"sphinx-gallery","links":{"html":"https://skillfed.io/packages/sphinx-gallery","md":"https://skillfed.io/packages/sphinx-gallery.md","pypi":"https://pypi.org/project/sphinx-gallery/"},"maintenance":{"status":"active"},"meta":{"latest_release":"2026-04-24","license_spdx":null,"license_treatment":"permissive","name":"sphinx-gallery","python_support":"supports_current","summary":"A Sphinx extension that builds an HTML gallery of examples from any set of Python scripts."},"popularity":{"monthly_downloads":650798,"position":5556,"tier":"top_15000"},"security":{"n_vulnerabilities":0},"version":"0.21.0"}
