Sphinx needs extension for managing needs/requirements and specifications
Project description
Complete documentation: http://sphinx-needs.readthedocs.io/en/latest/
Attention: sphinxcontrib-needs got renamed to sphinx-needs. This affects also the URLs for documentation and repository:
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 sphinx_needs-1.0.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 645cba8e342566625157a447376781fcab4b64d97aa377652eeef30dc7ae1a5c |
|
MD5 | 39208c47425f315922dc8d522310a913 |
|
BLAKE2b-256 | 83aef80dabe56ded4619a14d6bbc3f3637a76cd3f49ef3ed290a9b8e389635ec |