Skip to main content

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/sphinx-needs/master/packages/sphinx-needs/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/sphinx-needs/master/packages/sphinx-needs/docs/_images/need_2.png

Take a look into our tutorial 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/sphinx-needs/master/packages/sphinx-needs/docs/_images/needtable_1.png https://raw.githubusercontent.com/useblocks/sphinx-needs/master/packages/sphinx-needs/docs/_images/needflow_1.png https://raw.githubusercontent.com/useblocks/sphinx-needs/master/packages/sphinx-needs/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",]

Metadata

Release files for sphinx-needs 9.2.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for sphinx-needs 9.2.0
File Size Uploaded Provenance Actions
sphinx_needs-9.2.0.tar.gz 6.0 MB Without provenance Details for sphinx_needs-9.2.0.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for sphinx-needs 9.2.0
File Interpreter ABI Platform Actions
sphinx_needs-9.2.0-py3-none-any.whl Python 3 none any Details for sphinx_needs-9.2.0-py3-none-any.whl

Total release size: 6.9 MB

Release files / sphinx_needs-9.2.0.tar.gz

Download URL sphinx_needs-9.2.0.tar.gz
Size 6.0 MB
Tags Source
SHA-256 checksum
How to use checksums
35e2a3386e17c6b66c11f74fa69de9460f2e4c98fd1e41f39b4f00c496a1f5bb
BLAKE2b-256 checksum
How to use checksums
fe0dd6ae08401db799ea7fc9db353537bb91bc86bc09b936f97744feeae0cc9e
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via uv/0.13.7 {"installer":{"name":"uv","version":"0.13.7","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"26.04","id":"resolute","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

Release files / sphinx_needs-9.2.0-py3-none-any.whl

Download URL sphinx_needs-9.2.0-py3-none-any.whl
Size 924.9 kB
Tags Python 3
SHA-256 checksum
How to use checksums
50cb0f510a6f2a69a765e92eac844ec5be3f471ae28efe1ca7d09f29ed16e806
BLAKE2b-256 checksum
How to use checksums
7c2e97583c2fc51c79df184562d96686bd278766318a19b3448ecc72e6420f13
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via uv/0.13.7 {"installer":{"name":"uv","version":"0.13.7","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"26.04","id":"resolute","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

Security for sphinx-needs 9.2.0

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

9.2.0 This release

2 release files No provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page