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.1.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 999fcca21726b2a27ad2ec6eacc1e279fb0ab90a22760dafc85225a48788664f |
|
MD5 | 82ac87d0c80fe8693f9d7a9c27ea8989 |
|
BLAKE2b-256 | 12fdfba2feec49e796a5b9d902dac4307947fb04bb5d2389c250593569978de4 |
Hashes for sphinxcontrib_needs-0.7.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | d806d3cc646eeab25dbdc7cc111802ad206a92fc9a6a1a2bef5ce51edff52447 |
|
MD5 | 0c59f7d9aea8d04ab7cac08cd4b923a7 |
|
BLAKE2b-256 | 8d4e65a6d7fb52cfbf6e6722abaa568b5fc95ce53ca688b869c1ca8d053ddd7e |