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 sphinx-needs
Using pip
pip install sphinx-needs
If you wish to also use the plotting features of sphinx-needs (see needbar and needpie), you need to also install matplotlib, which is available via the plotting extra:
pip install sphinx-needs[plotting]
Using sources
git clone https://github.com/useblocks/sphinx-needs
cd sphinx-needs
pip install .
# or
poetry install
Activation
For final activation, please add sphinx_needs to the project’s extension list of your conf.py file.
extensions = ["sphinx_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-2.1.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 4440864463ecaf01d68e8dd7cddb58461b3ca7fecfaf8a6b3b863c78b695c25d |
|
MD5 | cf601afba16f2a7c862802c62e2f16cc |
|
BLAKE2b-256 | 2ccc8a5225a9afa5e7d228ac05579347954821753fa32552d4ed5389f384bff1 |