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.9.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 27c18f32c72ea3eb8f4662d54e4dcb7bb3261aa2ff4b77b54b2ee6688c3b7f47 |
|
MD5 | dd6a91002f74c5c47f06a75afc8ce6e1 |
|
BLAKE2b-256 | cf3ba42290b2029baca45c2a64497557f1f16773e7dedd687c14d81ea22e609a |
Hashes for sphinxcontrib_needs-0.7.9-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | fcbd5688e6114716673e04dde123ba3386c7435dc0667cb8cf70354f46eb79ff |
|
MD5 | 3826ad59fc878cf7a82677135385abb6 |
|
BLAKE2b-256 | 4bf26fc8e2fe9e6b412c2585f0535f3d67ead6f24d311fcbb152352f6cabf0b7 |