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.6.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 385c9ed876f6b092a6ca28e6e39b7014a4cc64be262afdf9b03851b63e561134 |
|
MD5 | 7708ffe7a45b4ba246d28445aaedbf9e |
|
BLAKE2b-256 | 904d7aa65575dc7bf9fd821feccb1a9bf0b4d3311de1c4bb22042c5a08d397a4 |
Hashes for sphinxcontrib_needs-0.5.6-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 5c22803afdc8d324cb65071bacb8b7438e250052021df14cbeac515b377f1de8 |
|
MD5 | fe7f456c2f7ab13c1d3a6569076d5a46 |
|
BLAKE2b-256 | 422a11bf428388faff15ebce6c9d681ccdada5845bd2b40f957afe50db96813a |