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 8.5.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-8.5.0.tar.gz | 28.2 MB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| sphinx_needs-8.5.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 31.0 MB
Release files / sphinx_needs-8.5.0.tar.gz
| Download URL | sphinx_needs-8.5.0.tar.gz |
|---|---|
| Size | 28.2 MB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
42d327baaf39f5041f692cb85609ef7023c0a73b688cde5803db444e577bb63d
|
|
BLAKE2b-256 checksum How to use checksums |
a8c29db8259372467a85da7d07aa9f642d292f56feadebb37caab73683bbcfed
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
python-requests/2.34.2
|
Release files / sphinx_needs-8.5.0-py3-none-any.whl
| Download URL | sphinx_needs-8.5.0-py3-none-any.whl |
|---|---|
| Size | 2.8 MB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
aa7548d1ec33cd66cd0223cf8d5c0a934dc4c67d67ad471b5351b817d5f02750
|
|
BLAKE2b-256 checksum How to use checksums |
0296e0a0b6fdf37460b7aaf8fb887922138aa23bbef7635ddaf09fb64823927a
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
python-requests/2.34.2
|
