Sphinx-Needs Timing Measurement: Sphinx-Needs

Build Duration: 113.84s       Build timestamp: 2026-08-22T10:38:08.170973       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.3032379 0.0013537 0.0001394 0.0032809 224 2353.4 0.27
2 _build_needextract build_needextract internal 0.0064468 0.0016117 0.0006251 0.0023662 4 378.5 0.01
3 calc_sum dyn_func user 0.0070523 0.0017631 0.0000090 0.0066259 4 73214.8 0.01
4 check_linked_values dyn_func user 0.0003733 0.0000622 0.0000033 0.0003495 6 10750.2 0.00
5 copy dyn_func user 0.0040358 0.0002124 0.0000009 0.0039995 19 434723.8 0.00
6 echo dyn_func user 0.0000015 0.0000008 0.0000007 0.0000009 2 136.9 0.00
7 links_from_content dyn_func user 0.0001906 0.0000953 0.0000760 0.0001147 2 150.9 0.00
8 test dyn_func user 0.0000077 0.0000077 0.0000077 0.0000077 1 100.0 0.00
9 filter_needs filtering internal 0.0225402 0.0032200 0.0000688 0.0120585 7 17516.2 0.02
10 filter_needs_and_parts filtering internal 0.0457244 0.0012701 0.0000435 0.0080960 36 18623.6 0.04
11 filter_single_need filtering internal 0.0313079 0.0000158 0.0000023 0.0006323 1978 27731.0 0.03
12 post_process_needs_data need_post_process internal 0.0860393 0.0860393 0.0860393 0.0860393 1 100.0 0.08
13 run need internal 0.1595724 0.0007457 0.0000048 0.0058914 214 122994.1 0.14
14 process_needflow_graphviz needflow_graphviz internal 0.0104571 0.0052286 0.0010540 0.0094031 2 892.1 0.01
15 process_needflow_plantuml needflow_plantuml internal 0.0302200 0.0050367 0.0006926 0.0194199 6 2804.0 0.03
16 run needflow internal 0.0028393 0.0000693 0.0000487 0.0001701 41 349.5 0.00
17 run needimport internal 0.0032928 0.0032928 0.0032928 0.0032928 1 100.0 0.00
18 process_needpie needpie internal 0.3771593 0.1885796 0.0315383 0.3456210 2 1095.9 0.33
19 process_needtables needtable internal 0.3638918 0.0519845 0.0013415 0.3261545 7 24311.9 0.32
20 process_needuml needuml internal 0.0086281 0.0028760 0.0003076 0.0047017 3 1528.5 0.01

Details

_build_needextract
(build_needextract, internal)

Amount 4.00000
Overall [s] 0.00645
Average [s] 0.00161
Min [s] 0.00063
Max [s] 0.00237
Min-Max spread [%] 378.50182
Ratio build time [%] 0.01
Max run analysis

Max: 0.002366188999985752

args

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

kwargs

{}
Show Meta Data

File: /home/docs/checkouts/readthedocs.org/user_builds/sphinx-needs/envs/latest/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 224.00000
Overall [s] 0.30324
Average [s] 0.00135
Min [s] 0.00014
Max [s] 0.00328
Min-Max spread [%] 2353.35189
Ratio build time [%] 0.27
Max run analysis

Max: 0.0032809020003696787

args

['<Need classes="need need-spec" ids="EX_CARD_PROFILE" refid="EX_CARD_PROFILE"><pa', "NeedItem(core={'id': 'EX_CARD_PROFILE', 'type': 'spec', 'type_name': 'Specificat", '<sphinx.application.Sphinx object at 0x7eff25ea7e10>']

kwargs

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

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

Line: 44

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.00705
Average [s] 0.00176
Min [s] 0.00001
Max [s] 0.00663
Min-Max spread [%] 73214.75309
Ratio build time [%] 0.01
Max run analysis

Max: 0.0066259350005566375

args

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

kwargs

{}
Show Meta Data

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

Line: 304

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**

.. syntax-example::

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


**Example 2**

.. syntax-example::

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

**Example 3**

.. syntax-example::

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

**Example 4**

.. syntax-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.00037
Average [s] 0.00006
Min [s] 0.00000
Max [s] 0.00035
Min-Max spread [%] 10750.20084
Ratio build time [%] 0.00
Max run analysis

Max: 0.0003494889997455175

args

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

kwargs

{}
Show Meta Data

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

Line: 175

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**

.. syntax-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*.

.. syntax-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"*.

.. syntax-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.

.. syntax-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.

.. syntax-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.

.. syntax-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.00404
Average [s] 0.00021
Min [s] 0.00000
Max [s] 0.00400
Min-Max spread [%] 434723.78308
Ratio build time [%] 0.00
Max run analysis

Max: 0.003999460000159161

args

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

kwargs

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

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

Line: 77

Function docs


Copies the value of one need option to another

.. syntax-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 [%] 136.92294
Ratio build time [%] 0.00
Max run analysis

Max: 0.0000008899996828404255

args

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

kwargs

{}
Show Meta Data

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

Line: 55

Function docs


.. versionadded:: 0.6.3

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

.. syntax-example::

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

filter_needs
(filtering, internal)

Amount 7.00000
Overall [s] 0.02254
Average [s] 0.00322
Min [s] 0.00007
Max [s] 0.01206
Min-Max spread [%] 17516.18209
Ratio build time [%] 0.02
Max run analysis

Max: 0.01205848999961745

args

["dict_values([NeedItem(core={'id': 'EX_CARD_PROFILE', 'type': 'spec', 'type_name'", "NeedsSphinxConfig(from_toml='ubproject.toml', from_toml_table=[], schema_validat", 'c.this_doc() and status is None', 'None']

kwargs

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

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

Line: 527

Function docs

None

filter_needs_and_parts
(filtering, internal)

Amount 36.00000
Overall [s] 0.04572
Average [s] 0.00127
Min [s] 0.00004
Max [s] 0.00810
Min-Max spread [%] 18623.55558
Ratio build time [%] 0.04
Max run analysis

Max: 0.00809603200013953

args

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

kwargs

{'filter_string': 'c.this_doc() and status is None', 'current_need': 'None', 'location': "('directives/needextend', 108)", 'append_warning': '', 'origin_docname': 'directives/needextend'}
Show Meta Data

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

Line: 549

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 1978.00000
Overall [s] 0.03131
Average [s] 0.00002
Min [s] 0.00000
Max [s] 0.00063
Min-Max spread [%] 27730.95951
Ratio build time [%] 0.03
Max run analysis

Max: 0.0006322660001387703

args

["NeedItem(core={'id': 'req_flow_001', 'type': 'req', 'type_name': 'Requirement', ", "NeedsSphinxConfig(from_toml='ubproject.toml', from_toml_table=[], schema_validat", "id in ['spec_flow_002', 'subspec_2'] or type == 'req'", 'ValuesView(<sphinx_needs.views.NeedsView object at 0x7eff181586c0>)']

kwargs

{'origin_docname': 'directives/needflow'}
Show Meta Data

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

Line: 718

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.00019
Average [s] 0.00010
Min [s] 0.00008
Max [s] 0.00011
Min-Max spread [%] 150.91481
Ratio build time [%] 0.00
Max run analysis

Max: 0.00011465299940027762

args

['<sphinx.application.Sphinx object at 0x7eff25ea7e10>', "NeedItem(core={'id': 'CON_SPEC_1', 'type': 'spec', 'type_name': 'Specification',", "{'EX_CARD_PROFILE': NeedItem(core={'id': 'EX_CARD_PROFILE', 'type': 'spec', 'typ"]

kwargs

{}
Show Meta Data

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

Line: 418

Function docs


Extracts need references from the content of a need.

All need-links set by using ``:need:`NEED_ID``` are extracted
from the parsed doctree node of the source need.

Same links are only added once.

.. versionchanged:: 8.0.0

Previously used a regex on raw RST source text to extract ``:need:`` references.
Now walks the parsed doctree, which correctly handles custom titles
(e.g. ``:need:`My Title ```) and nested content.

This function requires the source need to have a stored doctree node.
It will emit a warning and return an empty list for needs without a
stored node (e.g. external needs or need parts).

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.08604
Average [s] 0.08604
Min [s] 0.08604
Max [s] 0.08604
Min-Max spread [%] 100.00000
Ratio build time [%] 0.08
Max run analysis

Max: 0.08603934300026594

args

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

kwargs

{}
Show Meta Data

File: /home/docs/checkouts/readthedocs.org/user_builds/sphinx-needs/envs/latest/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.01046
Average [s] 0.00523
Min [s] 0.00105
Max [s] 0.00940
Min-Max spread [%] 892.10549
Ratio build time [%] 0.01
Max run analysis

Max: 0.009403113000189478

args

['<sphinx.application.Sphinx object at 0x7eff25ea7e10>', '<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/latest/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.03022
Average [s] 0.00504
Min [s] 0.00069
Max [s] 0.01942
Min-Max spread [%] 2804.01197
Ratio build time [%] 0.03
Max run analysis

Max: 0.019419942000240553

args

['<sphinx.application.Sphinx object at 0x7eff25ea7e10>', '<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/latest/lib/python3.11/site-packages/sphinx_needs/directives/needflow/_plantuml.py

Line: 218

Function docs

None

process_needpie
(needpie, internal)

Amount 2.00000
Overall [s] 0.37716
Average [s] 0.18858
Min [s] 0.03154
Max [s] 0.34562
Min-Max spread [%] 1095.87817
Ratio build time [%] 0.33
Max run analysis

Max: 0.3456210260001171

args

['<sphinx.application.Sphinx object at 0x7eff25ea7e10>', '<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/latest/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.36389
Average [s] 0.05198
Min [s] 0.00134
Max [s] 0.32615
Min-Max spread [%] 24311.89199
Ratio build time [%] 0.32
Max run analysis

Max: 0.3261544850001883

args

['<sphinx.application.Sphinx object at 0x7eff25ea7e10>', '<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/latest/lib/python3.11/site-packages/sphinx_needs/directives/needtable.py

Line: 139

Function docs


Replace all needtables nodes with a table of filtered nodes.

process_needuml
(needuml, internal)

Amount 3.00000
Overall [s] 0.00863
Average [s] 0.00288
Min [s] 0.00031
Max [s] 0.00470
Min-Max spread [%] 1528.51026
Ratio build time [%] 0.01
Max run analysis

Max: 0.004701667000517773

args

['<sphinx.application.Sphinx object at 0x7eff25ea7e10>', '<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/latest/lib/python3.11/site-packages/sphinx_needs/directives/needuml.py

Line: 566

Function docs

None

run
(need, internal)

Amount 214.00000
Overall [s] 0.15957
Average [s] 0.00075
Min [s] 0.00000
Max [s] 0.00589
Min-Max spread [%] 122994.10814
Ratio build time [%] 0.14
Max run analysis

Max: 0.005891417000384536

args

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

kwargs

{}
Show Meta Data

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

Line: 65

Function docs

None

run
(needflow, internal)

Amount 41.00000
Overall [s] 0.00284
Average [s] 0.00007
Min [s] 0.00005
Max [s] 0.00017
Min-Max spread [%] 349.49765
Ratio build time [%] 0.00
Max run analysis

Max: 0.00017010400006256532

args

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

kwargs

{}
Show Meta Data

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

Line: 89

Function docs

None

run
(needimport, internal)

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

Max: 0.0032928420005191583

args

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

kwargs

{}
Show Meta Data

File: /home/docs/checkouts/readthedocs.org/user_builds/sphinx-needs/envs/latest/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.000007650000043213367

args

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

kwargs

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

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

Line: 31

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.

.. syntax-example::

.. req:: test requirement

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

:return: single test string