sphinx-doc/sphinx

SVG image support for HTML

Open

#2240 opened on Jan 15, 2016

View on GitHub
 (18 comments) (1 reaction) (0 assignees)Python (5,625 stars) (1,985 forks)batch import
extensions:graphvizhelp wantedtype:enhancement

Description

Currently if I use .. image:: myfile.svg I've got image as a whole and can't click on elements of SVG picture. I can open image separately and then it works. It would be nice to have SVG with clickable elements.

Contributor guide

Tech stack
pythonhtml
Domain
documentationfrontend
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
mostly clear
Prerequisites
Understand Sphinx HTML writerBasic HTML and SVG knowledge
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
40
Research direction
The issue requests that SVG images included via `.. image::` directive have clickable elements in HTML output. Currently, Sphinx likely embeds the SVG as an `<img>` tag, which disables interactivity. Investigate the Sphinx HTML writer, specifically `sphinx/writers/html.py`, to understand how images are rendered. The issue comments (see https://github.com/sphinx doc/sphinx/issues/2240) discuss using `<object>` or inline SVG. A solution could involve conditionally inlining SVG content or using an `<object>` tag with the SVG source. No linked PRs or recent activity; the feature remains unimplemented. Begin by examining the `visit image` method in the HTML writer and consider modifying the node handling for SVG images.