Sphinx needs extension for managing needs/requirements and specifications
Project description
Complete documentation: http://sphinxcontrib-needs.readthedocs.io/en/latest/
Introduction
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:
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",]
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Hashes for sphinxcontrib-needs-0.7.2.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | ed286c46534262f46ae2cb1e05a7cd277d25aed5ca536e7bc9301160b7ed53d3 |
|
MD5 | 5104a4ef9d19985a848b37d8f32b6b46 |
|
BLAKE2b-256 | c6d8d08601e4b70c4acdaffd7f470c0983d399c5f1c79f4aee7885c4fd0faa02 |