Repository files navigation

Complete documentation:http://sphinx-needs.readthedocs.io/en/latest/

Attention:sphinxcontrib-needs got renamed tosphinx-needs. This affects also the URLs for documentation and repository:

• Docs:https://sphinx-needs.readthedocs.io/en/latest/
• Repo:https://github.com/useblocks/sphinx-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 ourExamples for morepictures and ideas how to useSphinx-Needs.

For filtering and analyzing needs,Sphinx-Needs provides different, powerful possibilities:

needtable	needflow	needpie

pip install sphinx-needs

If you wish to also use the plotting features of sphinx-needs (seeneedbar andneedpie), you need to also installmatplotlib, which is availablevia theplotting extra:

pip install sphinx-needs[plotting]

git clone https://github.com/useblocks/sphinx-needscd sphinx-needspip install.

For final activation, please add sphinx_needs to the project's extension list of yourconf.py file.

extensions= ["sphinx_needs",]