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.5.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 3ecf0da2987a82ee0c030347f0666401977a58b4e1b7302ed420d7a5d3d235b3 |
|
MD5 | 48fdea6c385f5c5cdfcca2ae50c2eb63 |
|
BLAKE2b-256 | 52b6155c902976cfdbfacb77481a702b813e50c7ff7e288466a033eb9ce14a85 |
Hashes for sphinxcontrib_needs-0.7.5-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 85da35165163b07e1c8f4772ea72fa7ddc4842f91bed65a1e70c9f6e037429b4 |
|
MD5 | 4ae186ea8d72e85ecfc41b5868ad17a3 |
|
BLAKE2b-256 | f08a9088c7240b1491080e50a566c0b692f461194b354a35276034840d744577 |