Sphinx-Needs Timing Measurement: Sphinx-Needs

Build Duration: 71.91s       Build timestamp: 2026-02-24T16:53:50.015201       Elements: 20

Overview

# Function Category Source Overall [s] Average [s] Min [s] Max [s] Amount Min/Max spread [%] Ratio build time[%]
1 build_need_repr build_need_repr internal 0.2351336 0.0010592 0.0000666 0.0028978 222 4352.9 0.33
2 _build_needextract build_needextract internal 0.0043798 0.0010949 0.0004810 0.0014079 4 292.7 0.01
3 calc_sum dyn_func user 0.0068115 0.0017029 0.0000074 0.0064345 4 86718.2 0.01
4 check_linked_values dyn_func user 0.0004400 0.0000733 0.0000016 0.0004236 6 25829.3 0.00
5 copy dyn_func user 0.0056908 0.0002995 0.0000007 0.0056609 19 832488.0 0.01
6 echo dyn_func user 0.0000014 0.0000007 0.0000006 0.0000008 2 139.7 0.00
7 links_from_content dyn_func user 0.0001839 0.0000920 0.0000078 0.0001762 2 2270.1 0.00
8 test dyn_func user 0.0000073 0.0000073 0.0000073 0.0000073 1 100.0 0.00
9 filter_needs filtering internal 0.0356748 0.0050964 0.0001237 0.0130226 7 10530.1 0.05
10 filter_needs_and_parts filtering internal 0.1150221 0.0031951 0.0000264 0.0088893 36 33697.2 0.16
11 filter_single_need filtering internal 0.1076584 0.0000223 0.0000163 0.0001780 4831 1095.5 0.15
12 post_process_needs_data need_post_process internal 0.0727984 0.0727984 0.0727984 0.0727984 1 100.0 0.10
13 run need internal 0.1262755 0.0005956 0.0000030 0.0050739 212 167454.3 0.18
14 process_needflow_graphviz needflow_graphviz internal 0.0065897 0.0032948 0.0008049 0.0057848 2 718.7 0.01
15 process_needflow_plantuml needflow_plantuml internal 0.0324946 0.0054158 0.0005120 0.0132961 6 2596.7 0.05
16 run needflow internal 0.0017910 0.0000512 0.0000322 0.0001607 35 499.8 0.00
17 run needimport internal 0.0025978 0.0025978 0.0025978 0.0025978 1 100.0 0.00
18 process_needpie needpie internal 0.2704935 0.1352467 0.0217148 0.2487787 2 1145.7 0.38
19 process_needtables needtable internal 0.3288073 0.0469725 0.0011052 0.2877427 7 26036.2 0.46
20 process_needuml needuml internal 0.0075770 0.0025257 0.0004031 0.0040566 3 1006.3 0.01

Details

_build_needextract
(build_needextract, internal)

Amount 4.00000
Overall [s] 0.00438
Average [s] 0.00109
Min [s] 0.00048
Max [s] 0.00141
Min-Max spread [%] 292.71277
Ratio build time [%] 0.01
Max run analysis

Max: 0.0014079249995120335

args

['<sphinx.application.Sphinx object at 0x79a5edf6ced0>', '<Needextract docname="directives/needextract" filter="id == \'EXTRACT_FEATURE_1\'"', "NeedItem(core={'id': 'EXTRACT_FEATURE_1', 'type': 'feature', 'type_name': 'Featu", "{'ids': ['needextract-directives/needextract-0'], 'classes': [], 'names': [], 'd"]

kwargs

{}
Show Meta Data

File: /home/docs/checkouts/readthedocs.org/user_builds/sphinx-needs/envs/7.0.0/lib/python3.11/site-packages/sphinx_needs/directives/needextract.py

Line: 168

Function docs

Creates a new need representation.

build_need_repr
(build_need_repr, internal)

Amount 222.00000
Overall [s] 0.23513
Average [s] 0.00106
Min [s] 0.00007
Max [s] 0.00290
Min-Max spread [%] 4352.94495
Ratio build time [%] 0.33
Max run analysis

Max: 0.002897799000493251

args

['<Need classes="[\'need\', \'need-req\']" ids="[\'EXTRA_REQ_001\']" refid="EXTRA_REQ_00', "NeedItem(core={'id': 'EXTRA_REQ_001', 'type': 'req', 'type_name': 'Requirement',", '<sphinx.application.Sphinx object at 0x79a5edf6ced0>']

kwargs

{'docname': 'configuration'}
Show Meta Data

File: /home/docs/checkouts/readthedocs.org/user_builds/sphinx-needs/envs/7.0.0/lib/python3.11/site-packages/sphinx_needs/layout.py

Line: 40

Function docs

Create an output representation for a need.

:param layout: Override layout from need data / config
:param style: Override style from need data / config
:param docname: Override docname from need data / config

The created table will have the following docutils structure::

- table
-- tgroup
--- colspec (partial used)
--- thead (not used)
--- tbody
---- row
----- entry
------ custom layout nodes

The level structure must be kept, otherwise docutils can not handle it!

calc_sum
(dyn_func, user)

Amount 4.00000
Overall [s] 0.00681
Average [s] 0.00170
Min [s] 0.00001
Max [s] 0.00643
Min-Max spread [%] 86718.19987
Ratio build time [%] 0.01
Max run analysis

Max: 0.006434490999708942

args

['<sphinx.application.Sphinx object at 0x79a5edf6ced0>', "NeedItem(core={'id': 'R_96D5E', 'type': 'req', 'type_name': 'Requirement', 'type", "{'EXTRA_REQ_001': NeedItem(core={'id': 'EXTRA_REQ_001', 'type': 'req', 'type_nam", 'hours', 'hours is not None and hours > 10']

kwargs

{}
Show Meta Data

File: /home/docs/checkouts/readthedocs.org/user_builds/sphinx-needs/envs/7.0.0/lib/python3.11/site-packages/sphinx_needs/functions/common.py

Line: 301

Function docs


Sums the values of a given option in filtered needs up to single number.

Useful e.g. for calculating the amount of needed hours for implementation of all linked
specification needs.


**Input data**

.. spec:: Do this
:id: sum_input_1
:hours: 7
:collapse: False

.. spec:: Do that
:id: sum_input_2
:hours: 15
:collapse: False

.. spec:: Do too much
:id: sum_input_3
:hours: 110
:collapse: False

**Example 2**

.. need-example::

.. req:: Result 1
:amount: [[calc_sum("hours")]]
:collapse: False


**Example 2**

.. need-example::

.. req:: Result 2
:amount: [[calc_sum("hours", "hours is not None and hours > 10")]]
:collapse: False

**Example 3**

.. need-example::

.. req:: Result 3
:links: sum_input_1; sum_input_3
:amount: [[calc_sum("hours", links_only="True")]]
:collapse: False

**Example 4**

.. need-example::

.. req:: Result 4
:links: sum_input_1; sum_input_3
:amount: [[calc_sum("hours", "hours is not None and hours > 10", "True")]]
:collapse: False

:param option: Options, from which the numbers shall be taken
:param filter: Filter string, which all needs must passed to get their value added.
:param links_only: If "True", only linked needs are taken into account.

:return: A float number

check_linked_values
(dyn_func, user)

Amount 6.00000
Overall [s] 0.00044
Average [s] 0.00007
Min [s] 0.00000
Max [s] 0.00042
Min-Max spread [%] 25829.31594
Ratio build time [%] 0.00
Max run analysis

Max: 0.0004236009999658563

args

['<sphinx.application.Sphinx object at 0x79a5edf6ced0>', "NeedItem(core={'id': 'S_78442', 'type': 'spec', 'type_name': 'Specification', 't", "{'EXTRA_REQ_001': NeedItem(core={'id': 'EXTRA_REQ_001', 'type': 'req', 'type_nam", 'progress', 'status', 'in progress', 'type == "req" ']

kwargs

{}
Show Meta Data

File: /home/docs/checkouts/readthedocs.org/user_builds/sphinx-needs/envs/7.0.0/lib/python3.11/site-packages/sphinx_needs/functions/common.py

Line: 172

Function docs


Returns a specific value, if for all linked needs a given option has a given value.

The linked needs can be filtered by using the ``filter`` option.

If ``one_hit`` is set to True, only one linked need must have a positive match for the searched value.

**Examples**

**Needs used as input data**

.. need-example::

.. req:: Input A
:id: clv_A
:status: in progress

.. req:: Input B
:id: clv_B
:status: in progress

.. spec:: Input C
:id: clv_C
:status: closed

**Example 1: Positive check**

Status gets set to *progress*.

.. need-example::

.. spec:: result 1: Positive check
:links: clv_A, clv_B
:status: [[check_linked_values('progress', 'status', 'in progress' )]]
:collapse: False

**Example 2: Negative check**

Status gets not set to *progress*, because status of linked need *clv_C* does not match *"in progress"*.

.. need-example::

.. spec:: result 2: Negative check
:links: clv_A, clv_B, clv_C
:status: [[check_linked_values('progress', 'status', 'in progress' )]]
:collapse: False

**Example 3: Positive check thanks of used filter**

status gets set to *progress*, because linked need *clv_C* is not part of the filter.

.. need-example::

.. spec:: result 3: Positive check thanks of used filter
:links: clv_A, clv_B, clv_C
:status: [[check_linked_values('progress', 'status', 'in progress', 'type == "req" ' )]]
:collapse: False

**Example 4: Positive check thanks of one_hit option**

Even *clv_C* has not the searched status, status gets anyway set to *progress*.
That's because ``one_hit`` is used so that only one linked need must have the searched
value.

.. need-example::

.. spec:: result 4: Positive check thanks of one_hit option
:links: clv_A, clv_B, clv_C
:status: [[check_linked_values('progress', 'status', 'in progress', one_hit=True )]]
:collapse: False

**Result 5: Two checks and a joint status**
Two checks are performed and both are positive. So their results get joined.

.. need-example::

.. spec:: result 5: Two checks and a joint status
:links: clv_A, clv_B, clv_C
:status: [[check_linked_values('progress', 'status', 'in progress', one_hit=True )]] [[check_linked_values('closed', 'status', 'closed', one_hit=True )]]
:collapse: False

:param result: value, which gets returned if all linked needs have parsed the checks
:param search_option: option name, which is used n linked needs for the search
:param search_value: value, which an option of a linked need must match
:param filter_string: Checks are only performed on linked needs, which pass the defined filter
:param one_hit: If True, only one linked need must have a positive check
:return: result, if all checks are positive

copy
(dyn_func, user)

Amount 19.00000
Overall [s] 0.00569
Average [s] 0.00030
Min [s] 0.00000
Max [s] 0.00566
Min-Max spread [%] 832487.98451
Ratio build time [%] 0.01
Max run analysis

Max: 0.005660918999637943

args

['<sphinx.application.Sphinx object at 0x79a5edf6ced0>', "NeedItem(core={'id': 'copy_4', 'type': 'test', 'type_name': 'Test Case', 'type_p", '<sphinx_needs.views.NeedsView object at 0x79a5e021f140>', 'title']

kwargs

{'filter': 'current_need["sections"][-1]==sections[-1]'}
Show Meta Data

File: /home/docs/checkouts/readthedocs.org/user_builds/sphinx-needs/envs/7.0.0/lib/python3.11/site-packages/sphinx_needs/functions/common.py

Line: 74

Function docs


Copies the value of one need option to another

.. need-example::

.. req:: copy-example
:id: copy_1
:tags: tag_1, tag_2, tag_3
:status: open

.. spec:: copy-example implementation
:id: copy_2
:status: [[copy("status", "copy_1")]]
:links: copy_1
:comment: [[copy("id")]]

Copies status of ``copy_1`` to own status.
Sets also a comment, which copies the id of own need.

.. test:: test of specification and requirement
:id: copy_3
:links: copy_2; [[copy('links', 'copy_2')]]
:tags: [[copy('tags', 'copy_1')]]

Set own link to ``copy_2`` and also copies all links from it.

Also copies all tags from copy_1.

If the filter_string needs to compare a value from the current need and the value is unknown yet,
you can reference the valued field by using ``current_need["my_field"]`` inside the filter string.
Small example::

.. test:: test of current_need value
:id: copy_4

The following copy command copies the title of the first need found under the same highest
section (headline):

:ndf:`copy('title', filter='current_need["sections"][-1]==sections[-1]')`

.. test:: test of current_need value
:id: copy_4

The following copy command copies the title of the first need found under the same highest
section (headline):

:ndf:`copy('title', filter='current_need["sections"][-1]==sections[-1]')`

:param option: Name of the option to copy
:param need_id: id of the need, which contains the source option. If None, current need is taken
:param upper: Is set to True, copied value will be uppercase
:param lower: Is set to True, copied value will be lowercase
:param filter: :ref:`filter_string`, which first result is used as copy source.
:return: string of copied need option

echo
(dyn_func, user)

Amount 2.00000
Overall [s] 0.00000
Average [s] 0.00000
Min [s] 0.00000
Max [s] 0.00000
Min-Max spread [%] 139.65505
Ratio build time [%] 0.00
Max run analysis

Max: 0.000000809999619377777

args

['<sphinx.application.Sphinx object at 0x79a5edf6ced0>', 'None', '<sphinx_needs.views.NeedsView object at 0x79a5e021f140>', 'first test']

kwargs

{}
Show Meta Data

File: /home/docs/checkouts/readthedocs.org/user_builds/sphinx-needs/envs/7.0.0/lib/python3.11/site-packages/sphinx_needs/functions/common.py

Line: 52

Function docs


.. versionadded:: 0.6.3

Just returns the given string back.
Mostly useful for tests.

.. need-example::

A nice :ndf:`echo("first test")` for a dynamic function.

filter_needs
(filtering, internal)

Amount 7.00000
Overall [s] 0.03567
Average [s] 0.00510
Min [s] 0.00012
Max [s] 0.01302
Min-Max spread [%] 10530.09865
Ratio build time [%] 0.05
Max run analysis

Max: 0.013022572999943804

args

["dict_values([NeedItem(core={'id': 'EXTRA_REQ_001', 'type': 'req', 'type_name': '", "NeedsSphinxConfig(from_toml='ubproject.toml', from_toml_table=[], schema_validat", 'id == "extend_test_002"', 'None']

kwargs

{'location': "('directives/needextend', 62)", 'append_warning': '', 'origin_docname': 'directives/needextend'}
Show Meta Data

File: /home/docs/checkouts/readthedocs.org/user_builds/sphinx-needs/envs/7.0.0/lib/python3.11/site-packages/sphinx_needs/filter_common.py

Line: 492

Function docs

none

filter_needs_and_parts
(filtering, internal)

Amount 36.00000
Overall [s] 0.11502
Average [s] 0.00320
Min [s] 0.00003
Max [s] 0.00889
Min-Max spread [%] 33697.19191
Ratio build time [%] 0.16
Max run analysis

Max: 0.008889318999536044

args

["dict_values([NeedItem(core={'id': 'EXTRA_REQ_001', 'type': 'req', 'type_name': '", "NeedsSphinxConfig(from_toml='ubproject.toml', from_toml_table=[], schema_validat"]

kwargs

{'filter_string': 'id == "extend_test_002"', 'current_need': 'None', 'location': "('directives/needextend', 62)", 'append_warning': '', 'origin_docname': 'directives/needextend'}
Show Meta Data

File: /home/docs/checkouts/readthedocs.org/user_builds/sphinx-needs/envs/7.0.0/lib/python3.11/site-packages/sphinx_needs/filter_common.py

Line: 514

Function docs


Filters given needs based on a given filter string.
Returns all needs, which pass the given filter.

:param needs: list of needs, which shall be filtered
:param config: NeedsSphinxConfig object
:param filter_string: strings, which gets evaluated against each need
:param current_need: current need, which uses the filter.
:param location: source location for error reporting (docname, line number)
:param append_warning: additional text to append to any failed filter warning

:return: list of found needs

filter_single_need
(filtering, internal)

Amount 4831.00000
Overall [s] 0.10766
Average [s] 0.00002
Min [s] 0.00002
Max [s] 0.00018
Min-Max spread [%] 1095.45230
Ratio build time [%] 0.15
Max run analysis

Max: 0.00017801099966163747

args

["NeedItem(core={'id': 'EXTRA_REQ_001', 'type': 'req', 'type_name': 'Requirement',", "NeedsSphinxConfig(from_toml='ubproject.toml', from_toml_table=[], schema_validat", 'search(r"([a-zA-Z0-9_.+-]+@[a-zA-Z0-9-]+\\.[a-zA-Z0-9-.]+$)", title)', '<sphinx_needs.views.NeedsAndPartsListView object at 0x79a5e0941500>', 'None']

kwargs

{'filter_compiled': '<code object <module> at 0x79a5d75e4b90, file "<string>", line 1>', 'origin_docname': 'filter'}
Show Meta Data

File: /home/docs/checkouts/readthedocs.org/user_builds/sphinx-needs/envs/7.0.0/lib/python3.11/site-packages/sphinx_needs/filter_common.py

Line: 642

Function docs


Checks if a single need/need_part passes a filter_string

:param need: the data for a single need
:param config: NeedsSphinxConfig object
:param filter_string: string, which is used as input for eval()
:param needs: list of all needs
:param current_need: set the current_need in the filter context as this, otherwise the need itself
:param filter_compiled: An already compiled filter_string to save time
:param origin_docname: The origin docname that the filter was called from, if any

:return: True, if need passes the filter_string, else False

links_from_content
(dyn_func, user)

Amount 2.00000
Overall [s] 0.00018
Average [s] 0.00009
Min [s] 0.00001
Max [s] 0.00018
Min-Max spread [%] 2270.11604
Ratio build time [%] 0.00
Max run analysis

Max: 0.00017616100012673996

args

['<sphinx.application.Sphinx object at 0x79a5edf6ced0>', "NeedItem(core={'id': 'CON_SPEC_1', 'type': 'spec', 'type_name': 'Specification',", "{'EXTRA_REQ_001': NeedItem(core={'id': 'EXTRA_REQ_001', 'type': 'req', 'type_nam"]

kwargs

{}
Show Meta Data

File: /home/docs/checkouts/readthedocs.org/user_builds/sphinx-needs/envs/7.0.0/lib/python3.11/site-packages/sphinx_needs/functions/common.py

Line: 406

Function docs


Extracts links from content of a need.

All need-links set by using ``:need:`NEED_ID``` get extracted.

Same links are only added once.

Example:

.. req:: Requirement 1
:id: CON_REQ_1

.. req:: Requirement 2
:id: CON_REQ_2

.. spec:: Test spec
:id: CON_SPEC_1
:links: [[links_from_content()]]

This specification cares about the realisation of:

* :need:`CON_REQ_1`
* :need:`My need `

.. spec:: Test spec 2
:id: CON_SPEC_2
:links: [[links_from_content('CON_SPEC_1')]]

Links retrieved from content of :need:`CON_SPEC_1`

Used code of **CON_SPEC_1**::

.. spec:: Test spec
:id: CON_SPEC_1
:links: [[links_from_content()]]

This specification cares about the realisation of:

* :need:`CON_REQ_1`
* :need:`CON_REQ_2`

.. spec:: Test spec 2
:id: CON_SPEC_2
:links: [[links_from_content('CON_SPEC_1')]]

Links retrieved from content of :need:`CON_SPEC_1`

:param need_id: ID of need, which provides the content. If not set, current need is used.
:param filter: :ref:`filter_string`, which a found need-link must pass.
:return: List of linked need-ids in content

post_process_needs_data
(need_post_process, internal)

Amount 1.00000
Overall [s] 0.07280
Average [s] 0.07280
Min [s] 0.07280
Max [s] 0.07280
Min-Max spread [%] 100.00000
Ratio build time [%] 0.10
Max run analysis

Max: 0.0727983819997462

args

['<sphinx.application.Sphinx object at 0x79a5edf6ced0>']

kwargs

{}
Show Meta Data

File: /home/docs/checkouts/readthedocs.org/user_builds/sphinx-needs/envs/7.0.0/lib/python3.11/site-packages/sphinx_needs/directives/need.py

Line: 344

Function docs

In-place post-processing of needs data.

This should be called after all needs (and extend) data has been collected.

This function is idempotent;
it will only be run on the first call, and will not be run again.

After this function has been run, one should assume that the needs data is finalised,
and so in principle should be treated as read-only.

process_needflow_graphviz
(needflow_graphviz, internal)

Amount 2.00000
Overall [s] 0.00659
Average [s] 0.00329
Min [s] 0.00080
Max [s] 0.00578
Min-Max spread [%] 718.68217
Ratio build time [%] 0.01
Max run analysis

Max: 0.00578475900056219

args

['<sphinx.application.Sphinx object at 0x79a5edf6ced0>', '<document source="/home/docs/checkouts/readthedocs.org/user_builds/sphinx-needs/', 'directives/needflow', '[<NeedflowGraphiz: >, <NeedflowGraphiz: >, <NeedflowGraphiz: >, <NeedflowGraphiz']

kwargs

{}
Show Meta Data

File: /home/docs/checkouts/readthedocs.org/user_builds/sphinx-needs/envs/7.0.0/lib/python3.11/site-packages/sphinx_needs/directives/needflow/_graphviz.py

Line: 46

Function docs

none

process_needflow_plantuml
(needflow_plantuml, internal)

Amount 6.00000
Overall [s] 0.03249
Average [s] 0.00542
Min [s] 0.00051
Max [s] 0.01330
Min-Max spread [%] 2596.68035
Ratio build time [%] 0.05
Max run analysis

Max: 0.013296093999997538

args

['<sphinx.application.Sphinx object at 0x79a5edf6ced0>', '<document source="/home/docs/checkouts/readthedocs.org/user_builds/sphinx-needs/', 'directives/needflow', '[<NeedflowPlantuml: >, <NeedflowPlantuml: >, <NeedflowPlantuml: >, <NeedflowPlan']

kwargs

{}
Show Meta Data

File: /home/docs/checkouts/readthedocs.org/user_builds/sphinx-needs/envs/7.0.0/lib/python3.11/site-packages/sphinx_needs/directives/needflow/_plantuml.py

Line: 186

Function docs

none

process_needpie
(needpie, internal)

Amount 2.00000
Overall [s] 0.27049
Average [s] 0.13525
Min [s] 0.02171
Max [s] 0.24878
Min-Max spread [%] 1145.66281
Ratio build time [%] 0.38
Max run analysis

Max: 0.24877865100006602

args

['<sphinx.application.Sphinx object at 0x79a5edf6ced0>', '<document source="/home/docs/checkouts/readthedocs.org/user_builds/sphinx-needs/', 'directives/needpie', '[<Needpie: >, <Needpie: >, <Needpie: >, <Needpie: >, <Needpie: >, <Needpie: >, <']

kwargs

{}
Show Meta Data

File: /home/docs/checkouts/readthedocs.org/user_builds/sphinx-needs/envs/7.0.0/lib/python3.11/site-packages/sphinx_needs/directives/needpie.py

Line: 111

Function docs

none

process_needtables
(needtable, internal)

Amount 7.00000
Overall [s] 0.32881
Average [s] 0.04697
Min [s] 0.00111
Max [s] 0.28774
Min-Max spread [%] 26036.19833
Ratio build time [%] 0.46
Max run analysis

Max: 0.28774269099994854

args

['<sphinx.application.Sphinx object at 0x79a5edf6ced0>', '<document source="/home/docs/checkouts/readthedocs.org/user_builds/sphinx-needs/', 'directives/needtable', '[<Needtable: >, <Needtable: >, <Needtable: >, <Needtable: >, <Needtable: >, <Nee']

kwargs

{}
Show Meta Data

File: /home/docs/checkouts/readthedocs.org/user_builds/sphinx-needs/envs/7.0.0/lib/python3.11/site-packages/sphinx_needs/directives/needtable.py

Line: 123

Function docs


Replace all needtables nodes with a table of filtered nodes.

process_needuml
(needuml, internal)

Amount 3.00000
Overall [s] 0.00758
Average [s] 0.00253
Min [s] 0.00040
Max [s] 0.00406
Min-Max spread [%] 1006.25662
Ratio build time [%] 0.01
Max run analysis

Max: 0.004056632999891008

args

['<sphinx.application.Sphinx object at 0x79a5edf6ced0>', '<document source="/home/docs/checkouts/readthedocs.org/user_builds/sphinx-needs/', 'directives/needuml', '[<Needuml: >, <Needuml: >, <Needuml: >, <Needuml: >, <Needuml: >, <Needuml: >, <']

kwargs

{}
Show Meta Data

File: /home/docs/checkouts/readthedocs.org/user_builds/sphinx-needs/envs/7.0.0/lib/python3.11/site-packages/sphinx_needs/directives/needuml.py

Line: 562

Function docs

none

run
(need, internal)

Amount 212.00000
Overall [s] 0.12628
Average [s] 0.00060
Min [s] 0.00000
Max [s] 0.00507
Min-Max spread [%] 167454.31786
Ratio build time [%] 0.18
Max run analysis

Max: 0.005073867000646715

args

['<sphinx_needs.directives.need.NeedDirective object at 0x79a5e89d6fd0>']

kwargs

{}
Show Meta Data

File: /home/docs/checkouts/readthedocs.org/user_builds/sphinx-needs/envs/7.0.0/lib/python3.11/site-packages/sphinx_needs/directives/need.py

Line: 65

Function docs

none

run
(needflow, internal)

Amount 35.00000
Overall [s] 0.00179
Average [s] 0.00005
Min [s] 0.00003
Max [s] 0.00016
Min-Max spread [%] 499.81654
Ratio build time [%] 0.00
Max run analysis

Max: 0.0001607409994903719

args

['<sphinx_needs.directives.needflow._directive.NeedflowDirective object at 0x79a5e']

kwargs

{}
Show Meta Data

File: /home/docs/checkouts/readthedocs.org/user_builds/sphinx-needs/envs/7.0.0/lib/python3.11/site-packages/sphinx_needs/directives/needflow/_directive.py

Line: 69

Function docs

none

run
(needimport, internal)

Amount 1.00000
Overall [s] 0.00260
Average [s] 0.00260
Min [s] 0.00260
Max [s] 0.00260
Min-Max spread [%] 100.00000
Ratio build time [%] 0.00
Max run analysis

Max: 0.0025977880004575127

args

['<sphinx_needs.directives.needimport.NeedimportDirective object at 0x79a5d77f1490']

kwargs

{}
Show Meta Data

File: /home/docs/checkouts/readthedocs.org/user_builds/sphinx-needs/envs/7.0.0/lib/python3.11/site-packages/sphinx_needs/directives/needimport.py

Line: 60

Function docs

none

test
(dyn_func, user)

Amount 1.00000
Overall [s] 0.00001
Average [s] 0.00001
Min [s] 0.00001
Max [s] 0.00001
Min-Max spread [%] 100.00000
Ratio build time [%] 0.00
Max run analysis

Max: 0.00000734999957785476

args

['<sphinx.application.Sphinx object at 0x79a5edf6ced0>', "NeedItem(core={'id': 'R_A6A4E', 'type': 'req', 'type_name': 'Requirement', 'type", '<sphinx_needs.views.NeedsView object at 0x79a5e021f140>', 'arg_1', '[1, 2, 3]']

kwargs

{'my_keyword': 'awesome'}
Show Meta Data

File: /home/docs/checkouts/readthedocs.org/user_builds/sphinx-needs/envs/7.0.0/lib/python3.11/site-packages/sphinx_needs/functions/common.py

Line: 28

Function docs


Test function for dynamic functions in sphinx needs.

Collects every given args and kwargs and returns a single string, which contains their values/keys.

.. need-example::

.. req:: test requirement

:ndf:`test('arg_1', [1,2,3], my_keyword='awesome')`

:return: single test string