Complete documentation: http://sphinxcontrib-needs.readthedocs.io/en/latest/
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 Examples for more pictures and ideas how to use Sphinx-Needs.
For filtering and analyzing needs, Sphinx-Needs provides different, powerful possibilities:
Installation
Using poetry
poetry add sphinxcontrib-needs
Using pip
pip install sphinxcontrib-needs
Using sources
git clone https://github.com/useblocks/sphinxcontrib-needs cd sphinxcontrib-needs pip install .
Activation
Add sphinxcontrib.needs to your extensions:
extensions = ["sphinxcontrib.needs",]
Metadata
Release files for sphinxcontrib-needs 0.7.9
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| sphinxcontrib-needs-0.7.9.tar.gz | 2.3 MB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| sphinxcontrib_needs-0.7.9-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 4.9 MB
Release files / sphinxcontrib-needs-0.7.9.tar.gz
| Download URL | sphinxcontrib-needs-0.7.9.tar.gz |
|---|---|
| Size | 2.3 MB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
27c18f32c72ea3eb8f4662d54e4dcb7bb3261aa2ff4b77b54b2ee6688c3b7f47
|
|
BLAKE2b-256 checksum How to use checksums |
cf3ba42290b2029baca45c2a64497557f1f16773e7dedd687c14d81ea22e609a
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
poetry/1.1.13 CPython/3.9.12 Linux/5.13.0-1022-azure
|
Release files / sphinxcontrib_needs-0.7.9-py3-none-any.whl
| Download URL | sphinxcontrib_needs-0.7.9-py3-none-any.whl |
|---|---|
| Size | 2.6 MB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
fcbd5688e6114716673e04dde123ba3386c7435dc0667cb8cf70354f46eb79ff
|
|
BLAKE2b-256 checksum How to use checksums |
4bf26fc8e2fe9e6b412c2585f0535f3d67ead6f24d311fcbb152352f6cabf0b7
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
poetry/1.1.13 CPython/3.9.12 Linux/5.13.0-1022-azure
|