Installation

Using pip

pip install sphinxcontrib-needs

Using sources

git clone https://github.com/useblocks/sphinxcontrib-needs
python setup.py install

Activation

For final activation, please add sphinxcontrib.needs to the project’s extension list of your conf.py file:

extensions = ["sphinxcontrib.needs",]

For the full configuration, please read Configuration.

Using docker

Sphinx-Needs got also dockerized by Till Witt.

See https://github.com/tlwt/sphinxneeds-docker for actual documentation and hints how to use it.