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 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 sphinxcontrib-needs-0.7.7.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 8b4a23b4ddb05d9162310acd23d79973d00ae3668025d009a771662aeac7e88e |
|
MD5 | 762b0a28fdb2470a96719bfa469147c0 |
|
BLAKE2b-256 | 9baa046e84e17f2cb481797e5c79ae3d4bb38b05bfb0358751f5ce2743c4218a |
Hashes for sphinxcontrib_needs-0.7.7-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 98467a0ed5215f820c7ab3af82f66cc4672bb1c8cc9a81657329ece59a29f183 |
|
MD5 | a009d008f776fd949856a13ced5fb6af |
|
BLAKE2b-256 | 56aa3bf89790c17d26b4ba508dcb7a2b59b50e8064d6e77b09f0a8aacd168670 |