sphinx-need-sysml

Sphinx extension for SysML v2 need types and diagrams via sphinx-needs and PlantUML.

Contents

Overview

sphinx-need-sysml registers 14 SysML v2 need types and 15 extra fields with sphinx-needs, enabling you to write SysML v2 structural and behavioral elements directly in reStructuredText. It also provides three high-level diagram directives that generate PlantUML diagrams:

  • .. needsysml-bdd:: — Block Definition Diagrams

  • .. needsysml-ibd:: — Internal Block Diagrams

  • .. needsysml-req:: — Requirements Diagrams

Quick Example

.. partdef:: Engine
   :id: PD-001

   Engine block definition.

.. needsysml-bdd:: PD-001
   :depth: 2

See Installation for setup instructions and Vehicle System: Full SysML v2 Demo for a complete worked example.

References