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.6.2.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 5a8f0a33f1b872eec61b092d6e925562ac0d20172e9404e32d4e9f820b56b198 |
|
MD5 | 5ecd34c5c2f784a9d4d02ca0727f317a |
|
BLAKE2b-256 | 463510005d8f29a222dd1178227abf0d04935cd25b017e7a747cbc0c241987e5 |
Hashes for sphinxcontrib_needs-0.6.2-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 112477025b657cef3d4ffaacd3d9083eaeabfcd19f0698515654254e1c67f2cb |
|
MD5 | 97f9212068fe77b2219fa402051fc087 |
|
BLAKE2b-256 | c0e96296b63ad27fe9f8d8ff209226930c7fbe9b12fb2115a07552f921260d76 |