needlist

New in version 0.2.0.

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

.. needlist::
   :tags: main_example

Options

Note

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

Supported options:

show_status

Flag for adding status information of found needs to list result.

If a filtered need has no status information, no status output is written for this need.

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

show_tags

Flag for adding tag information of found needs to list result.

If a filtered need has no tag information, no tag output is written for this need.

show_filters

If set, the used filter is added below of result list:

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

Used filter: status(done OR implemented)