Sphinx needs extension for managing needs/requirements and specifications
Project description
Complete, rendered documentation: http://sphinxcontrib-needs.readthedocs.io/en/latest/
This package contains the needs Sphinx extension.
It allows the definition, linking and filtering of 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).
Example
For the rendered output and more documentation, please visit http://sphinxcontrib-needs.readthedocs.io/en/latest/
.. req:: My first requirement
:status: open
:tags: requirement; test; awesome
This is my **first** requirement!!
.. note:: It's awesome :)
.. spec:: Specification of a requirement
:id: OWN_ID_123
.. impl:: Implementation for specification
:id: impl_01
:links: OWN_ID_123
.. test:: Test for XY
:status: implemented
:tags: test; user_interface; python27
:links: OWN_ID_123; impl_01
This test checks the implementation of :ref:`impl_01` for spec :ref:`OWN_ID_123` inside a
Python 2.7 environment.
What is a need?
A need is a generic object, which can become everything you want for your sphinx documentation: A requirement, a test case, a user story, a bug, an employee, a product or anything else.
But whatever you chose it shall be and how many of them you need, each need is handled the same way.
Each need can contain:
a title (required)
an unique id (optional. Gets calculated based on title if not given)
a description, which supports fully rst and sphinx extensions (optional)
a status (optional)
several tags (optional)
several links to other needs (optional)
You can create filterable overviews of defined needs by using the needfilter directive:
.. needfiler:: :status: open;in_progress :tags: tests; test; test_case; :layout: table
Installation
Using pip
pip install sphinxcontrib-needs
Using sources
git clone https://github.com/useblocks/sphinxcontrib-needs python setup.py install
Activation
Add sphinxcontrib.needs to your extensions:
extensions = ["sphinxcontrib.needs",]
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for sphinxcontrib-needs-0.4.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 6cef8db619bff717ccad5c9ba68add3b42ead279deb6e897ab61ce4ae0038071 |
|
MD5 | 69546294562623fae81ae85fd20d95d6 |
|
BLAKE2b-256 | c5b0ccfc53f01ad12884ca2be38791eb43f573c9a5ce67f7c3fa76a55d6c6df4 |
Hashes for sphinxcontrib_needs-0.4.0-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | b993c81b8efb3d70b1631c4236213cd9607bb5292597ef823852cb3b184686a4 |
|
MD5 | 938e4f7c7c479ceec5eafc91acbd2f3a |
|
BLAKE2b-256 | 2620e128e9a95626d1f7be8b1e25e811a61f8d9cd01f71d5bc0cf5fab14a517c |