Installation¶

Requirements¶

pip install sphinx-needs-tree-map

uv add sphinx-needs-tree-map

For development, clone the repository and install in editable mode:

git clone https://github.com/patdhlk/sphinx-needs-tree-map.git
cd sphinx-needs-tree-map
pip install -e ".[dev,docs]"

Or with uv:

git clone https://github.com/patdhlk/sphinx-needs-tree-map.git
cd sphinx-needs-tree-map
uv sync --group dev --group docs

Add the extension to your Sphinx conf.py:

extensions = [
    "sphinx_needs",
    "sphinx_needs_tree_map",
]

Note

sphinx_needs must be listed before sphinx_needs_tree_map in the extensions list, or it will be automatically loaded as a dependency.

After installation, you can verify it works by adding a simple treemap to any document:

.. needtreemap::

Build your documentation and you should see an interactive treemap visualization.