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.5.4.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 0ae3d4c0686ec28b3a39587d7b9b7f921de690c98bbfc18a8c47edb07a0bf4e6 |
|
MD5 | 68492b5c97d7b61329f48e7c22f01cac |
|
BLAKE2b-256 | 1a9e231875c7e7b72a2cec89d53a6ad481a317ba5d85a76fc8a212cd34c1340d |
Hashes for sphinxcontrib_needs-0.5.4-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 8221a5bc18c9eb2d9ea23c4558f2f9987be117823ff1a3473fef44c4fb398e68 |
|
MD5 | 32fd60a3b5d7d7b01674cefa040148db |
|
BLAKE2b-256 | 0b0a58550d3ff1d70ee0b7b0ae3ee76df759ec5cbfc2604e5a496905a920a0d4 |