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.3.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 18c7b9376fdcc208663f34f67544cb854d9d19f7ffb9f92defe696fbe9bb1077 |
|
MD5 | a2a8db7040f87a87cdb09bee65a829d4 |
|
BLAKE2b-256 | 34146a827baf10319e1e12c939b3b6064c58e66d8700cf5fe2540690d41b3c96 |
Hashes for sphinxcontrib_needs-0.6.3-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | bffbdae2ff5f3d5847f08218caaa2456594a7d701430eddb4a0bcb4206b179cb |
|
MD5 | 8c664db43aaaafb42c14a43918d4ed4d |
|
BLAKE2b-256 | b69691d0b4717bc1f04f74b208e4fbdd0aaab34e1dd65aa259c87e2c7e0bb981 |