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.