Skip to main content

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:

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

Activation

For final activation, please add sphinx_needs to the project’s extension list of your conf.py file.

extensions = ["sphinx_needs",]

Project details


Download files

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

Source Distribution

sphinx_needs-5.1.0.tar.gz (27.3 MB view details)

Uploaded Source

Built Distribution

sphinx_needs-5.1.0-py3-none-any.whl (2.6 MB view details)

Uploaded Python 3

File details

Details for the file sphinx_needs-5.1.0.tar.gz.

File metadata

  • Download URL: sphinx_needs-5.1.0.tar.gz
  • Upload date:
  • Size: 27.3 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: python-requests/2.32.3

File hashes

Hashes for sphinx_needs-5.1.0.tar.gz
Algorithm Hash digest
SHA256 23a0ca1dfe733a0a58e884b59ce53a8b63a530f0ac87ae5ab0d40f05f853fbe7
MD5 d76266a3ce9445e03991693566b30f38
BLAKE2b-256 14cc6ec2b659b9b7f453cb5c5bd70efef21d083bee7f68525ecf5a1462d540ff

See more details on using hashes here.

File details

Details for the file sphinx_needs-5.1.0-py3-none-any.whl.

File metadata

  • Download URL: sphinx_needs-5.1.0-py3-none-any.whl
  • Upload date:
  • Size: 2.6 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: python-requests/2.32.3

File hashes

Hashes for sphinx_needs-5.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 7adf3763478e91171146918d8af4a22aa0fc062a73856f1ebeb6822a62cbe215
MD5 b250f19d1dca9fe06bb92c20f06497a5
BLAKE2b-256 335176e0975800ced3179936ae9544a9c2dd5ddddc70dfef6668f9f22f8b87bf

See more details on using hashes here.

Supported by

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