Skip to content

Commit

Permalink
docs: Fix instructions for CairoSVG
Browse files Browse the repository at this point in the history
  • Loading branch information
ewuerger authored and Wuestengecko committed Sep 25, 2023
1 parent 43b4dc3 commit 0d390e6
Showing 1 changed file with 3 additions and 21 deletions.
24 changes: 3 additions & 21 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -247,29 +247,11 @@ Render diagrams in untrusted jupyter notebooks

The SVG format relies on a stylesheet, however in untrusted notebooks any
stylesheets are stripped. As a workaround we support the PNG format. For this
the `cairosvg`__ library is needed which depends on additional binaries. They
can be installed with the following commands based on your OS:
the `cairosvg`__ library is needed which depends on additional libraries. See
the official `CairoSVG documentation`__ for detailed instructions.

__ https://pypi.org/project/CairoSVG/

On linux
""""""""

Make sure to use the right package manager. For debian/ubuntu:

.. code::
sudo apt-get install libcairo2
For windows
"""""""""""

- Download and execute the `latest GTK installer`__.

__ https://github.com/tschoonj/GTK-for-Windows-Runtime-Environment-Installer/releases/tag/2022-01-04

- Reboot to add the path to the installed compiled libraries into your system
environment PATH
__ https://cairosvg.org/documentation/#installation

Contributing
------------
Expand Down

0 comments on commit 0d390e6

Please sign in to comment.