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 | 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

sphinxcontrib-needs-0.5.6.tar.gz (2.3 MB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

sphinxcontrib_needs-0.5.6-py3-none-any.whl (2.5 MB view details)

Uploaded Python 3

File details

Details for the file sphinxcontrib-needs-0.5.6.tar.gz.

File metadata

  • Download URL: sphinxcontrib-needs-0.5.6.tar.gz
  • Upload date:
  • Size: 2.3 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.23.0 setuptools/46.1.3 requests-toolbelt/0.9.1 tqdm/4.45.0 CPython/3.8.2

File hashes

Hashes for sphinxcontrib-needs-0.5.6.tar.gz
Algorithm Hash digest
SHA256 385c9ed876f6b092a6ca28e6e39b7014a4cc64be262afdf9b03851b63e561134
MD5 7708ffe7a45b4ba246d28445aaedbf9e
BLAKE2b-256 904d7aa65575dc7bf9fd821feccb1a9bf0b4d3311de1c4bb22042c5a08d397a4

See more details on using hashes here.

File details

Details for the file sphinxcontrib_needs-0.5.6-py3-none-any.whl.

File metadata

  • Download URL: sphinxcontrib_needs-0.5.6-py3-none-any.whl
  • Upload date:
  • Size: 2.5 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.23.0 setuptools/46.1.3 requests-toolbelt/0.9.1 tqdm/4.45.0 CPython/3.8.2

File hashes

Hashes for sphinxcontrib_needs-0.5.6-py3-none-any.whl
Algorithm Hash digest
SHA256 5c22803afdc8d324cb65071bacb8b7438e250052021df14cbeac515b377f1de8
MD5 fe7f456c2f7ab13c1d3a6569076d5a46
BLAKE2b-256 422a11bf428388faff15ebce6c9d681ccdada5845bd2b40f957afe50db96813a

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page