needlist

New in version 0.2.0.

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

Example

.. needlist::
   :tags: main_example

Result

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.

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.

show_filters

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

Show example

Example

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

Result

Used filter: status(done OR implemented)

common filters