theoworks-sphinx 0.1.0

TheoWorks Sphinx extension — emits the needs-graph JSON (needs.json) consumed by the TheoWorks viewer, editor, and CLI

theoworks-sphinx

The TheoWorks Sphinx extension. It runs inside a sphinx-needs build and emits the needs graph (needs.json) consumed by the TheoWorks viewer, editor, and theoworks-cli.

Install

pip install theoworks-sphinx

This pulls in theoworks-core, sphinx, and sphinx-needs.

Usage

Add the extension to your project's conf.py (after sphinx_needs):

extensions = [
    "sphinx_needs",
    "theoworks_sphinx",
]

Build as usual; the extension writes the enriched needs graph alongside the Sphinx output:

sphinx-build -b html docs docs/_build

You can also extract the graph directly from Python (no HTML build required):

from theoworks_sphinx import extract_project, write_needs_graph

graph = extract_project("path/to/project")
write_needs_graph(graph, "needs-graph.json")

License

Apache-2.0. See LICENSE.