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 pip
pip install sphinxcontrib-needs
Using sources
git clone https://github.com/useblocks/sphinxcontrib-needs python setup.py 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.5.5.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 5d68579f89c2bc56235a570488f62ce22e61f58493b2f6f6eeca334eee9b68a3 |
|
MD5 | 167fedbc29d80026b502ee367dbe485b |
|
BLAKE2b-256 | 0b325518cd21ea5bbf2977b08479dda173e734928323177c3353ef176cfc5522 |
Hashes for sphinxcontrib_needs-0.5.5-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | b2633b34e4a1334238b7e55afbee90da9fbdaf505b031e5449987697ff78a497 |
|
MD5 | 6e7094621f713ac92a9e08e9d56f9112 |
|
BLAKE2b-256 | f1c8cb4e7f564cd7b6c3f0acd5d928139b8aa64c24cf062542c803f3ab9e9c6e |