1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
|
.. _needlist:
needlist
========
.. versionadded:: 0.2.0
**needlist** creates a list of elements based on the result of given filters.
.. need-example::
.. needlist::
:tags: main_example
Options
-------
.. note::
**needlist** supports the full filtering possibilities of **Sphinx-Needs**.
Please see :ref:`filter` for more information.
.. _needlist_show_status:
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.
.. need-example::
.. needlist::
:show_status:
:status: done; implemented
.. _needlist_show_tags:
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.
.. need-example::
.. needlist::
:show_tags:
:status: done; implemented
.. _needlist_show_filters:
show_filters
~~~~~~~~~~~~
If set, we add the used filter below the needlist results:
.. need-example::
.. needlist::
:show_filters:
:status: done; implemented
common filters
~~~~~~~~~~~~~~
* :ref:`option_status`
* :ref:`option_tags`
* :ref:`option_types`
* :ref:`option_filter`
|
