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 pip
pip install sphinxcontrib-needs
Using sources
git clone https://github.com/useblocks/sphinxcontrib-needs python setup.py 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.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | fb7c163410e32b286435f53e4ce06cf91f9de59262abc7ae7b6170373105060e |
|
MD5 | 37490cf6b22fd9493c6bd45fb6153735 |
|
BLAKE2b-256 | 35b23732b99a99afab8cab2632e10f9976c2d888ed1d9657f05256fddc51a283 |
Hashes for sphinxcontrib_needs-0.6.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | b4fae74e1fcf185ab2da39a67702beb2ac407cb774f6ebcb7a6cf6f2c8362c0e |
|
MD5 | b69929c2306f293eb2e27ea03b2816eb |
|
BLAKE2b-256 | 6a2f69597ce589a0f5fedf56d8bac9ed196f5179ef49558dd625e69a975185e7 |