Sphinx needs extension for managing needs/requirements and specifications
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:
- Docs: https://sphinx-needs.readthedocs.io/en/latest/
- Repo: https://github.com/useblocks/sphinx-needs
Sphinx-Needs allows the definition, linking and filtering of class-like need-objects, which are by default:
- 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:
poetry add sphinxcontrib-needs
pip install sphinxcontrib-needs
git clone https://github.com/useblocks/sphinxcontrib-needs cd sphinxcontrib-needs pip install .
Add sphinxcontrib.needs to your extensions:
extensions = ["sphinxcontrib.needs",]
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Hashes for sphinx_needs-1.0.1-py3-none-any.whl