Sphinx-needsΒΆ

This package integrates with the sphinx-needs package to allow for the creation of requirements and test cases from Rust code.

To use this feature, add sphinx_needs to your conf.py:

extensions = [
    "sphinx_rust",
    "sphinx_needs",
    "sphinxcontrib.plantuml"
]
rust_crates = [
    "../path/to/crate",
    ...
]
...

We can then create requirements and test cases from Rust code:

.. rubric:: Need-list example

.. needlist::
    :tags: rust

.. rubric:: Need-table example

.. needtable::
    :tags: rust
    :style: table

Need-list example

Need-table example

ID

Title

Status

Type

Outgoing

Tags

RUST001

Integrate rust with sphinx

req

rust

RUST002

Analyze a rust package

req

rust

RUST003

Represent a crate

in-progress

req

rust

RUST004

Represent a module

in-progress

req

rust

RUST005

Represent a struct

in-progress

req

rust

RUST006

Represent an enum

in-progress

req

rust