Git Product home page Git Product logo

sphinxcontrib-svg-links's Introduction

sphinxcontrib-svg-links

sphinxcontrib-svg-links in short svg-links let you link from SVG elements anywhere, even to Sphinx labels.

Installation

Install the package

$ pip install sphinxcontrib-svg-links

Add the extension to your conf.py


extensions = [
        ...,
        
        'sphinxcontrib_svg_links.extension',
        
        ...,
        ]

How it works

In this SVG file fragment

        <a xlink:href="svglink://#other-reference-label">
            <ellipse cx="235" cy="220" rx="40" ry="40" fill="rgb(255, 255, 255)" stroke="rgb(0, 0, 0)"
                     pointer-events="all"/>
        </a>

the ellipse element links to svglink://#ellipse-reference-label which is a pseudo URI. Such links can be comfortably set utilizing draw.io or any other capable SVG editor.

The pseudo URI svglink://#ellipse-reference-label is a reference to a Spinx label defined elsewhere:

.. _ellipse-reference-label:

The queen of elements - the ellipse
-----------------------------------

svg-links introduces a new attribute svglinks to the image, and figure directive.

.. image:: ../diagram.svg
  :svglinks: True
  :width: 400
  :alt: Beautiful diagram

.. figure:: ../diagram.svg
  :svglinks: True
  :width: 400
  :alt: Beautiful diagram
    
  What a nice diagram!
    

If the svglinks attribute exists and is True, then the SVG will be not treated as an image but will be embedded as an HTML . So you can decide which SVG image will have links and which may not.

svg-links will the parse the SVG file and replace the pseudo URIs with relative links to the sphinx labels in the document.

Demonstration

ToDo

sphinxcontrib-svg-links's People

Contributors

volkerjaenisch avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.