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.1.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 2933e1312c01ec7f1fff55368fce88b88ac687d89b3862b991d2e7b50b601373 |
|
MD5 | 240c9f864a808c955beb9b455925dea0 |
|
BLAKE2b-256 | 6de82afc298b56348889c19b1f446349108d49677f7050cb0e246242f7545e29 |