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
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-1.0.3-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | bf845e2a929dff18d29126ecce01056ec987b07378f3c12ef394c2a4b98bf39c |
|
MD5 | c6ee6425a1de89882fa078d5262861ad |
|
BLAKE2b-256 | b7f331401ef0e316267d01da562c7bcaa371f18d71e3a17327482d1b9bd52b47 |