Skip to main content

Sphinx needs extension for managing needs/requirements and specifications

Project description

Complete documentation:

Attention: sphinxcontrib-needs got renamed to sphinx-needs. This affects also the URLs for documentation and repository:


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:





Using poetry

poetry add sphinx-needs

Using pip

pip install sphinx-needs

Using sources

git clone
cd sphinx-needs
pip install .
# or
poetry install


For final activation, please add sphinx_needs to the project’s extension list of your 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-1.3.0.tar.gz (2.4 MB view hashes)

Uploaded source

Built Distribution

sphinx_needs-1.3.0-py3-none-any.whl (2.6 MB view hashes)

Uploaded py3

Supported by

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