Skip to main content
Pre-release

This release is a pre-release and may not be stable for production use.

sphinx-graphml

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.

Metadata

Release files for sphinx-graphml 0.1b5

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for sphinx-graphml 0.1b5
File Size Uploaded Provenance Actions
sphinx_graphml-0.1b5.tar.gz 1.1 MB Without provenance Details for sphinx_graphml-0.1b5.tar.gz

Release files / sphinx_graphml-0.1b5.tar.gz

Download URL sphinx_graphml-0.1b5.tar.gz
Size 1.1 MB
Tags Source
SHA-256 checksum
How to use checksums
f3e29e13b251ed4be339c3da972c16c34437aa0e78a7c1989ab18bf6ef96312a
BLAKE2b-256 checksum
How to use checksums
2f91a5a2fb0442a1a1af12582366fd1b8abd542e2d6d08c8411ed4a0d82bc189
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/1.13.0 pkginfo/1.5.0.1 requests/2.21.0 setuptools/40.8.0 requests-toolbelt/0.9.1 tqdm/4.31.1 CPython/3.6.7

Security for sphinx-graphml 0.1b5

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page