Skip to content

useblocks/sphinx-needs

This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.

Folders and files

NameName
Last commit message
Last commit date

Latest commit

49e91cb Â· Aug 30, 2023
Aug 28, 2023
Sep 20, 2022
Aug 30, 2023
Nov 30, 2021
Aug 30, 2023
Aug 28, 2023
Jan 17, 2023
Apr 19, 2021
Aug 21, 2023
Aug 28, 2023
Feb 8, 2023
Aug 21, 2023
May 3, 2022
Jan 6, 2021
Aug 21, 2023
Nov 9, 2022
Aug 21, 2023
Nov 29, 2022
Aug 21, 2023
Aug 29, 2023

Repository files navigation

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:

https://raw.githubusercontent.com/useblocks/sphinxcontrib-needs/master/docs/_images/need_1.png

Layout and style of needs can be highly customized, so that a need can also look like:

https://raw.githubusercontent.com/useblocks/sphinxcontrib-needs/master/docs/_images/need_2.png

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:

needtable needflow needpie
https://raw.githubusercontent.com/useblocks/sphinxcontrib-needs/master/docs/_images/needtable_1.png https://raw.githubusercontent.com/useblocks/sphinxcontrib-needs/master/docs/_images/needflow_1.png https://raw.githubusercontent.com/useblocks/sphinxcontrib-needs/master/docs/_images/needpie_1.png

Installation

Using poetry

poetry add sphinx-needs

Using pip

pip install sphinx-needs

Note

Prior version 1.0.1 the package was named sphinxcontrib-needs.

Using sources

git clone https://github.com/useblocks/sphinx-needs
cd sphinx-needs
pip install .
# or
poetry install

Activation

For final activation, please add sphinx_needs to the project's extension list of your conf.py file.

extensions = ["sphinx_needs",]

Note

Prior version 1.0.1 the extensions was called sphinxcontrib.needs.