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.2.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 69b70b185dd2f3b9f4b3218505c126f01588bb24814536e86442116f27376296 |
|
MD5 | efef7b61302427e327b2859d7d306960 |
|
BLAKE2b-256 | 76dd38162e8834ac2a49cdffa7f459dfd01563f436865ad6dc5fadf9dd4cc02d |
Hashes for sphinxcontrib_needs-0.5.2-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | bf304e81cccc250c58e5fb4aca4bd8d2c0011763e36c30d27512f0e2e484a861 |
|
MD5 | 10d6499bccc30730a7349a05c5d28b1a |
|
BLAKE2b-256 | f5f741f16b327efef98e6dce7f9bc4cb303110d409141294f24b300160f6481e |