Skip to main content

GraphML charts embedding extension for Sphinx

Project description

A GraphML charts embedding extension for Sphinx.

This extensions simply uses the GraphMLViewer tool provided by yWorks. Admittedly, it is based on Flash and will no longer be supported from the end of 2020, but this is still the easiest and best option to display a .graphml chart created with yEd in a browser. Hopefully by the end of 2020 there will be adequate svg-based solutions.

Installation

As simple as it can be with pip:

pip install sphinx-graphml

Usage

Add the extension name to your conf.py:

extensions = [
   ...
   'sphinx_graphml',
   ...
]

In your documentation:

.. graphml:: rel/path/to/my_graph.graphml
   :height: 500px

(the default height is 300px)

Issues

If you load your documentation from a file (and not from a web server) using a flash player version higher than 23, you won’t see the charts. See this article and this other one for workarounds.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

sphinx_graphml-0.1b5.tar.gz (1.1 MB view hashes)

Uploaded source

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page