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
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
|
.. _needpie:
needpie
========
.. versionadded:: 0.5.0
``needpie`` adds a pie-chart to your documentation.
.. need-example::
.. needpie:: My pie chart
type == 'req'
type == 'spec'
10
If you provide an argument for the ``needpie``, we use it as the title.
Each content line gets interpreted either as static float/int value or as a :ref:`filter_string`.
The amount of found needs by the filter string is then used as value.
You can use :ref:`filter_func` with Python codes to define custom filters for ``needpie``.
.. note::
This generates multiple image files per ``needpie`` and allows
the document engine to pick the appropriate image type (vector or raster).
Options
-------
**Example with all options used:**
.. need-example::
.. needpie:: Requirement status
:labels: Open, In progress, Closed
:legend:
:shadow:
:explode: 0, 0.3, 0
:colors: #ffcc00, #444444, limegreen
:text_color: crimson
:style: dark_background
type == 'req' and status == 'open'
type == 'req' and status == 'in progress'
type == 'req' and status == 'closed'
labels
~~~~~~
Use ``:labels:`` to set labels for each value.
``:labels:`` must get a comma separated string and the amount of labels must match the amount of
values/lines from content.
.. need-example::
.. needpie:: Requirement status
:labels: Open, In progress, Closed
type == 'req' and status == 'open'
type == 'req' and status == 'in progress'
type == 'req' and status == 'closed'
legend
~~~~~~
You can place a legend on the right side of the pie chart by setting the ``:legend:`` flag.
The ``:legend:`` flag does not support any values.
.. need-example::
.. needpie:: Requirement status
:labels: Open, In progress, Closed
:legend:
type == 'req' and status == 'open'
type == 'req' and status == 'in progress'
type == 'req' and status == 'closed'
explode
~~~~~~~
``:explode:`` takes a comma-separated list of floats and defines how much space a specific pie-part
moves of from center.
The amount of values for ``:explode:`` must match the amount of values / content lines.
Useful values for ``:explode:`` are between ``0`` and ``0.3``
.. need-example::
.. needpie:: Requirement status
:explode: 0,0.2,0
type == 'req' and status == 'open'
type == 'req' and status == 'in progress'
type == 'req' and status == 'closed'
shadow
~~~~~~
``:shadow:`` activates a shadow in the pie chart. It does not support any further values.
.. need-example::
.. needpie:: Requirement status
:explode: 0,0.2,0
:shadow:
type == 'req' and status == 'open'
type == 'req' and status == 'in progress'
type == 'req' and status == 'closed'
colors
~~~~~~
``:color:`` takes a comma separated list of color names and uses them for the pie pieces.
See `Matplotlib documentation of supported colors <https://matplotlib.org/stable/gallery/color/named_colors.html>`_
for a complete list of color names.
But besides names, the ``:colors:`` option also supports hex-values like ``#ffcc00``.
.. need-example::
.. needpie:: Requirement status
:colors: lightcoral, gold, #555555
type == 'req' and status == 'open'
type == 'req' and status == 'in progress'
type == 'req' and status == 'closed'
text_color
~~~~~~~~~~
``:text_color:`` defines the color for text inside the pie pieces and the labels.
.. note:: Setting the ``:text_color:`` option does not change the legend and title color.
.. need-example::
.. needpie:: Requirement status
:text_color: w
type == 'req' and status == 'open'
type == 'req' and status == 'in progress'
type == 'req' and status == 'closed'
style
~~~~~
``:style:`` activates a complete style (colors, font, sizes) for a pie chart.
It takes a string, which must match the
`supported Matplotlib style names <https://matplotlib.org/3.1.1/gallery/style_sheets/style_sheets_reference.html>`_.
Useful styles are for example:
* default
* classic
* Solarize_Light2
* dark_background
* grayscale
.. need-example::
.. needpie:: Requirement status
:style: Solarize_Light2
type == 'req' and status == 'open'
type == 'req' and status == 'in progress'
type == 'req' and status == 'closed'
overlapping labels
~~~~~~~~~~~~~~~~~~
In the past we had overlapping labels. See following diagram.
.. image:: /_images/need_pie_overlapping_labels.png
:alt: Example of a needpie with overlapping labels
Now overlapping labels are removed, and we automatically add a legend with removed information.
.. need-example::
.. needpie:: Requirement status
:labels: New, Open, In progress, Closed, Outdated, Removed
90
7
6
5
0
0
|
