sphinxcontrib-needs
Sphinx-Needs allows the definition, linking and filtering of class-like need-objects, which are by default:
- requirements
- specifications
- implementations
- test cases.
This list can be easily customized via configuration (for instance to support bugs or user stories).
A default requirement need looks like:
Layout and style of needs can be highly customized, so that a need can also look like:
Take a look into our Examples for more pictures and ideas how to use Sphinx-Needs.
For filtering and analyzing needs, Sphinx-Needs provides different, powerful possibilities:
For filtering and analyzing needs, Sphinx-Needs provides different, powerful possibilities:
| needtable | needflow | needpie |
|---|---|---|
 |  |  |
Installation
Using poetry
poetry add sphinxcontrib-needs
Using pip
pip install sphinxcontrib-needs
Using sources
git clone https://github.com/useblocks/sphinxcontrib-needs
cd sphinxcontrib-needs
pip install .
Activation
Add sphinxcontrib.needs to your extensions:
extensions = ["sphinxcontrib.needs",]
