Skip to content

jdillard/sphinx-visualised

Repository files navigation

Sphinx visualization extension

A Sphinx extension to generate interactive visualizations.

PyPI version Parallel safe

Installing

Directly install via pip by using:

pip install sphinx-visualised

Add sphinx_visualised to the extensions array in your Sphinx conf.py. For example:

extensions = ['sphinx_visualised']

Usage

After building the docs, open one of the following in the browser:

  • /_static/link-graph.html
  • /_static/toctree-graph.html

Inspiration