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.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | a05c780b38d164e1e290226ef69021f935352e9c643b3d037013dec8253375bb |
|
MD5 | 6b82e273a995a8195096198c4a3da61f |
|
BLAKE2b-256 | 42d09b2413eae6b0674356dd7f06c113b63548c5603888c2ad1b19909c9a9146 |
Hashes for sphinxcontrib_needs-0.7.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 859f70e37a0a80b323eb0dcea566ff771d8ff7f9adeb79bcb05f5edba701cfec |
|
MD5 | 09d44f3ab96f86d910681e93630ff33c |
|
BLAKE2b-256 | 586e9fadf73ea5aa36925e3bbc0be91af29f76ba550e6770023d7227faeb7412 |