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

Sphinx-Needs can request issues and other data from external services like GitHub.

Embed tickets, requirements and other external information from specific services into your documentation by using Services.

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

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: Connect to external services FEATURE_3 ../_images/arrow-right-circle.svg
tags: introduction
links outgoing: SPEC_1
links incoming: extend_test_001

Sphinx-Needs can request issues and other data from external services like GitHub.

Embed tickets, requirements and other external information from specific services into your documentation by using Services.

Feature: Automated data handling FEATURE_4 ../_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.