Installation¶

Requirements¶

• Python ≥ 3.10

• Sphinx ≥ 4.0

• sphinx-needs ≥ 1.0

• sphinxcontrib-plantuml (optional, required for diagram rendering)

• PlantUML binary (optional, required for diagram rendering)

Install from PyPI¶

pip install sphinx-need-sysml

For diagram rendering, also install:

pip install sphinxcontrib-plantuml

And ensure the plantuml binary is on your PATH, or set it in conf.py:

plantuml = "/usr/bin/plantuml"

Enable the Extension¶

Add to your conf.py:

extensions = [
    "sphinx_needs",
    "sphinxcontrib.plantuml",  # optional but recommended
    "sphinx_need_sysml",
]

# Required for clickable diagram links in HTML output
plantuml_output_format = "svg"

Verify Installation¶

python -c "import sphinx_need_sysml; print(sphinx_need_sysml.VERSION)"

This should print 0.1.0 (or your installed version).