sphinx-doc/sphinx

SVG image support for HTML

Open

#2,240 建立於 2016年1月15日

在 GitHub 查看
 (18 留言) (1 反應) (0 負責人)Python (5,625 star) (1,985 fork)batch import
extensions:graphvizhelp wantedtype:enhancement

描述

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.

貢獻者指南

技術棧
pythonhtml
領域
documentationfrontend
議題類型
feature
難度面向新貢獻者的預計實作難度，1 表示很小改動，5 表示專家級工作。
3
預計時間有經驗貢獻者完成調查、實作、測試並準備 pull request 的粗略時間範圍。
1-2 days
活動狀態議題目前的可參與程度：新鮮、活躍、陳舊、阻塞或等待維護者輸入。
stale
清晰度議題是否清楚說明預期改動、驗收標準和下一步。
mostly clear
前置要求
Understand Sphinx HTML writerBasic HTML and SVG knowledge
新手友善度1-100 的估計分數，表示該議題對首次貢獻者的友善程度。
40
研究方向
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.