Skip to content
Back to top
View this page
Edit this page

# needlist

Added in version 0.2.0.

needlist creates a list of elements based on the result of given filters.

Example 1

    .. needlist::
       :tags: main_example

No needs passed the filters

## Options

Note

needlist supports the full filtering possibilities of Sphinx-Needs. Please see Filtering needs for more information.

### show_status

Flag for adding status information to the needs list results filtered.

If a filtered need has no status information, we write no status output for the need.

Example 2

    .. needlist::
       :show_status:
       :status: done; implemented

EXT-FEATURE-B: Feature B (done)
STYLE_005: My automatically styled requirement (implemented)
EX_ROW_1: Implemented spec (implemented)
T_C3893: Test for XY (implemented)

### show_tags

Flag for adding tag information to the needs list results filtered.

If a filtered need has no tag information, we write no tag output for the need.

Example 3

    .. needlist::
       :show_tags:
       :status: done; implemented

EXT-FEATURE-B: Feature B [B]
STYLE_005: My automatically styled requirement [style_example]
EX_ROW_1: Implemented spec [ex_row_color]
T_C3893: Test for XY [test; user_interface; python27]

### show_filters

If set, we add the used filter below the needlist results:

Example 4

    .. needlist::
       :show_filters:
       :status: done; implemented

EXT-FEATURE-B: Feature B
STYLE_005: My automatically styled requirement
EX_ROW_1: Implemented spec
T_C3893: Test for XY

Used filter: status(done OR implemented)

### common filters

- status

- tags

- types

- filter