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.3.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | e4019469076e53f1c26831a4233618235064d476bfd72858dd25d59770959bad |
|
MD5 | 52301bc1c140c10717a719102aa675b5 |
|
BLAKE2b-256 | 5d9f6e7b5d6693847ec9278ed7f4f0aa21f5dbb76170df4d183eedb8449a0904 |
Hashes for sphinxcontrib_needs-0.5.3-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 291bea03b44f297b0d09c32e5e323ab2619c94534c5ad977c55f977598e3ec91 |
|
MD5 | 2de3b2eb29e78f9309e4eacb69a43681 |
|
BLAKE2b-256 | 4cc292370efd1cd7f1a56dee2bfaa7195b8e79c8e12b48e6bd2f723c8be4ee03 |