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
Built Distribution
Hashes for sphinxcontrib-needs-0.7.8.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 9808ee9679b30e52959e6be81afe507527a274949400ed4db16bc5a7e6e2d184 |
|
MD5 | 099dc5e709cbb5ffbdc008a6b5b360ec |
|
BLAKE2b-256 | f23292a599e7a5d8eff31b88953d5ae5c0746102c25c5ab44a19c822eeb249a1 |
Hashes for sphinxcontrib_needs-0.7.8-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | e6be4d24e268ca65c2fa1443cbc64f95c12fe7b1c178a87ee3576f9cf58b7894 |
|
MD5 | a23c7267f542fafd7dc2968c050ff739 |
|
BLAKE2b-256 | 80e75e2fec961d911d880172b8f104c5c84407b40f7b12604c375f89fcaccd45 |