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 -e .
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.1.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | dede3c4b0737e482bce11f78df08392801772929d5917cb5c9e89a35be765d43 |
|
MD5 | 211500fc6a42529fb7dddbeee55f4aa5 |
|
BLAKE2b-256 | 557f0ac37353efe522419d37d4741803228e6a2779377ee3fa06161c65996f7d |
Hashes for sphinxcontrib_needs-0.6.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 770c32f5f7c5507ef126deebdfe156f40d0513cb8ca2bd18386a5a528789ed3c |
|
MD5 | 3d881defa634922ba2b2690ab0fa0233 |
|
BLAKE2b-256 | bc9555356f73e9f60861c9c50d4e90cfa1cb75e071146168b9d029bcf242545a |