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:
Layout and style of needs can be highly customized, so that a need can also look like:
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:
|
|
|
Installation
Using pip
pip install sphinx-needsIf 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",]
Release files for sphinx-needs 9.0.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| sphinx_needs-9.0.0.tar.gz | 5.8 MB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| sphinx_needs-9.0.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 6.6 MB
Release files / sphinx_needs-9.0.0.tar.gz
| Download URL | sphinx_needs-9.0.0.tar.gz |
|---|---|
| Size | 5.8 MB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
5f48748438648775443d08f7f989b860d7ba8cf6a6d93eebd1098cfba4e8aa31
|
|
BLAKE2b-256 checksum How to use checksums |
d703f5a61ed3c35f767df20392ec60d6435c9fd5f2cb6c22e8343e9d81ea333f
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
uv/0.13.1 {"installer":{"name":"uv","version":"0.13.1","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","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.0.0-py3-none-any.whl
| Download URL | sphinx_needs-9.0.0-py3-none-any.whl |
|---|---|
| Size | 777.9 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
4747ff220d064ed70cb2fc635bd2dc604d532f73b079af74cd55fe3161196ac8
|
|
BLAKE2b-256 checksum How to use checksums |
fdfbdfcd6f3cce8fedefa59c37382531ef5d65b693d5cf626faada71bc21de32
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
uv/0.13.1 {"installer":{"name":"uv","version":"0.13.1","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}
|
