Skip to main content

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:

https://raw.githubusercontent.com/useblocks/sphinxcontrib-needs/master/docs/_images/need_1.png

Layout and style of needs can be highly customized, so that a need can also look like:

https://raw.githubusercontent.com/useblocks/sphinxcontrib-needs/master/docs/_images/need_2.png

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:

needtable needflow needpie
https://raw.githubusercontent.com/useblocks/sphinxcontrib-needs/master/docs/_images/needtable_1.png https://raw.githubusercontent.com/useblocks/sphinxcontrib-needs/master/docs/_images/needflow_1.png https://raw.githubusercontent.com/useblocks/sphinxcontrib-needs/master/docs/_images/needpie_1.png

Installation

Using pip

pip install sphinxcontrib-needs

Using sources

git clone https://github.com/useblocks/sphinxcontrib-needs
python setup.py install

Activation

Add sphinxcontrib.needs to your extensions:

extensions = ["sphinxcontrib.needs",]

Project details


Release history Release notifications

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for sphinxcontrib-needs, version 0.5.3
Filename, size File type Python version Upload date Hashes
Filename, size sphinxcontrib_needs-0.5.3-py2.py3-none-any.whl (2.5 MB) File type Wheel Python version 3.6 Upload date Hashes View hashes
Filename, size sphinxcontrib-needs-0.5.3.tar.gz (2.3 MB) File type Source Python version None Upload date Hashes View hashes

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page