needextract

New in version 0.5.1.

needextract generates copies of filtered needs with custom layout and style.

It is mainly designed to support the customized creation of extracts from existing needs. For instance a supplier should get a copy of requirements, but shall not see all the internal meta-data.

.. needextract::
   :filter: type == 'feature'
   :layout: clean
   :style: green_border

Options

Note

needextract supports the full filtering possibilities of sphinx-needs. Please see Filtering needs for more information.

layout

layout overwrites the need-specific layout option and sets the same layout for each need. The style information is taken from the original need, if not overwritten by style.

See Layouts for a list of available layouts.

Example

.. needextract::
   :filter: id in ['FEATURE_3', 'FEATURE_4']
   :layout: focus_r

Result

For complex data chains between needs, Dynamic functions can be used to load and set changeable data automatically during documentation generation phase.

Sphinx-needs allows to customize needs-types, needs-options, colors, layouts, ids, checks, … .

The pages Configuration and Layouts & Styles are full of possibilities to adopt Sphinx-needs for your own processes and workflows.

style

style overwrites the need-specific style option and sets the same style for each need. The layout information is taken from the original need, if not overwritten by layout.

See Styles for a list of available styles.

Example

.. needextract::
   :filter: id in ['FEATURE_3', 'FEATURE_4']
   :style: blue_border

Result

Feature: Automated data handling FEATURE_3 ../_images/arrow-right-circle.svg
tags: introduction
links outgoing: SPEC_1

For complex data chains between needs, Dynamic functions can be used to load and set changeable data automatically during documentation generation phase.

Customizing everything
Feature
tags: introduction
links outgoing: SPEC_1

Sphinx-needs allows to customize needs-types, needs-options, colors, layouts, ids, checks, … .

The pages Configuration and Layouts & Styles are full of possibilities to adopt Sphinx-needs for your own processes and workflows.