Configuration Values

This page documents all configuration values available in sphinx-visualized. For installation instructions, see Getting started. For advanced usage, see Advanced Configuration.

visualized_clusters

  • Type: list of dictionaries

  • Default: [] (empty list)

  • Description: Defines clusters for grouping pages in the link graph visualization. See Configuring Link Clusters for detailed usage examples.

Added in version 0.5.0.

visualized_auto_cluster

  • Type: boolean

  • Default: False

  • Description: When enabled, automatically clusters pages based on their directory structure. See Automatic Clustering for more details.

Added in version 0.6.0.

visualized_projects

  • Type: list of strings

  • Default: [] (empty list)

  • Description: List of external Sphinx projects to integrate into the link graph visualization. See Integrating External Projects for detailed usage examples.

Added in version 0.9.0.