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.6.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | bbca131ca1bf4b4f868dca2f600f7fd07eb046d95b1d23a5a5639ac1e6f203e5 |
|
MD5 | b5c5af4f68571621f0d80debf97da686 |
|
BLAKE2b-256 | 604c5402a6c49c9b08c9c288e84476d04dbbf50283274505282828352b9b1666 |
Hashes for sphinxcontrib_needs-0.7.6-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 04a94cece70233fc7697607ae5ebdead902ce44fcd6d66b207928f4981404f46 |
|
MD5 | 36f07d3386aa268ef53282335550860d |
|
BLAKE2b-256 | 094a3aeeba2e5e8e723b66fbfea212b280494e5a2f36ce7a2d65882d59211a14 |