sphinx-doc/sphinx

SVG image support for HTML

Open

#2,240 opened on 2016年1月15日

GitHub で見る
 (18 comments) (1 reaction) (0 assignees)Python (5,625 stars) (1,985 forks)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
Issue 種別
feature
難度新しい貢献者にとっての実装難度です。1 は非常に小さな変更、5 は専門的な作業です。
3
推定時間経験ある貢献者が調査、実装、テスト、pull request 準備にかけるおおよその時間範囲です。
1-2 days
活動状況Issue が今どれだけ取り組みやすいかを示します。新しい、活発、古い、ブロック中、またはメンテナー入力待ちなどです。
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.