sphinx-needs-tree-map

StrictDoc-style tree map visualizations for sphinx-needs.

sphinx-needs-tree-map is a Sphinx extension that provides interactive treemap visualizations for your sphinx-needs documentation. It allows you to visualize requirements, specifications, and other need types in hierarchical treemaps using Plotly.js.

Installation

Get started with sphinx-needs-tree-map

Installation

Quick Start

Learn the basics in 5 minutes

Quick Start

Directive Reference

Complete directive options

needtreemap Directive

Examples

See treemaps in action

Examples

Features

• Interactive Treemaps: Visualize your requirements hierarchy using Plotly.js

• Multiple Hierarchy Modes: Organize by document structure, link relationships, or need types

• Flexible Filtering: Filter by type, status, tags, or custom filter expressions

• Customizable Colors: Configure colors for need types and statuses

• Click-to-Navigate: Click on any need in the treemap to jump to its documentation

• Dark Mode Support: Automatically adapts to light and dark themes

• Responsive Design: Works on all screen sizes

User Guide

• Installation
  • Requirements
  • Installing with pip
  • Installing with uv
  • Development Installation
  • Enabling the Extension
  • Verifying Installation
• Quick Start
  • Basic Treemap
  • Customizing the View
  • Complete Example
  • Next Steps
• needtreemap Directive
  • Basic Usage
  • Options Reference
  • Examples
• Configuration
  • Plotly.js CDN
  • Default Dimensions
  • Type Colors
  • Status Colors
  • Full Example
• Examples
  • Document Overview
  • Requirements Traceability
  • Status Dashboard
  • Filtered Views
  • Compact Visualizations
  • Size by Content Length
  • Size by Link Count
  • Example Project

Development

• API Reference
  • Extension Setup
  • Directives
  • Utilities
• Contributing
  • Contributing to sphinx-needs-tree-map
• Changelog
  • Changelog

Indices and tables

• Index

• Module Index

• Search Page