Sphinx-Needs Timing Measurement: Sphinx-Needs

Build Duration: 94.95s       Build timestamp: 2026-09-17T20:37:25.527053       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.3061723 0.0013668 0.0000767 0.0047250 224 6162.3 0.32
2 _build_needextract build_needextract internal 0.0067046 0.0016761 0.0004306 0.0028741 4 667.4 0.01
3 calc_sum dyn_func user 0.0065106 0.0016276 0.0000102 0.0060688 4 59673.4 0.01
4 check_linked_values dyn_func user 0.0003856 0.0000643 0.0000032 0.0003609 6 11419.3 0.00
5 copy dyn_func user 0.0039587 0.0002084 0.0000008 0.0039202 19 461194.6 0.00
6 echo dyn_func user 0.0000014 0.0000007 0.0000006 0.0000007 2 115.6 0.00
7 links_from_content dyn_func user 0.0002213 0.0001107 0.0000941 0.0001272 2 135.2 0.00
8 test dyn_func user 0.0000072 0.0000072 0.0000072 0.0000072 1 100.0 0.00
9 filter_needs filtering internal 0.0305580 0.0043654 0.0000535 0.0167006 7 31196.8 0.03
10 filter_needs_and_parts filtering internal 0.0546155 0.0014761 0.0000466 0.0126075 37 27047.8 0.06
11 filter_single_need filtering internal 0.0304746 0.0000154 0.0000023 0.0000987 1978 4311.6 0.03
12 post_process_needs_data need_post_process internal 0.0952680 0.0952680 0.0952680 0.0952680 1 100.0 0.10
13 run need internal 0.1173053 0.0006240 0.0000034 0.0027597 188 82110.5 0.12
14 process_needflow_graphviz needflow_graphviz internal 0.0107680 0.0053840 0.0010389 0.0097291 2 936.5 0.01
15 process_needflow_plantuml needflow_plantuml internal 0.0296118 0.0049353 0.0006664 0.0184419 6 2767.3 0.03
16 run needflow internal 0.0027756 0.0000677 0.0000455 0.0001966 41 431.9 0.00
17 run needimport internal 0.0029606 0.0029606 0.0029606 0.0029606 1 100.0 0.00
18 process_needpie needpie internal 0.3865364 0.1932682 0.0296004 0.3569360 2 1205.8 0.41
19 process_needtables needtable internal 0.1389106 0.0198444 0.0012827 0.0994751 7 7755.2 0.15
20 process_needuml needuml internal 0.0087338 0.0029113 0.0003367 0.0047469 3 1409.9 0.01

Details

_build_needextract
(build_needextract, internal)

Amount 4.00000
Overall [s] 0.00670
Average [s] 0.00168
Min [s] 0.00043
Max [s] 0.00287
Min-Max spread [%] 667.41641
Ratio build time [%] 0.01
Max run analysis

Max: 0.0028741220012307167

args

['<sphinx.application.Sphinx object at 0x72e6caf09310>', '<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: 228

Function docs

Creates a new need representation.

build_need_repr
(build_need_repr, internal)

Amount 224.00000
Overall [s] 0.30617
Average [s] 0.00137
Min [s] 0.00008
Max [s] 0.00472
Min-Max spread [%] 6162.34236
Ratio build time [%] 0.32
Max run analysis

Max: 0.004724975999124581

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 0x72e6caf09310>']

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.00651
Average [s] 0.00163
Min [s] 0.00001
Max [s] 0.00607
Min-Max spread [%] 59673.36869
Ratio build time [%] 0.01
Max run analysis

Max: 0.006068782000511419

args

['<sphinx.application.Sphinx object at 0x72e6caf09310>', "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.00039
Average [s] 0.00006
Min [s] 0.00000
Max [s] 0.00036
Min-Max spread [%] 11419.30627
Ratio build time [%] 0.00
Max run analysis

Max: 0.00036085000101593323

args

['<sphinx.application.Sphinx object at 0x72e6caf09310>', "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.00396
Average [s] 0.00021
Min [s] 0.00000
Max [s] 0.00392
Min-Max spread [%] 461194.55373
Ratio build time [%] 0.00
Max run analysis

Max: 0.0039201500003400724

args

['<sphinx.application.Sphinx object at 0x72e6caf09310>', "NeedItem(core={'id': 'copy_4', 'type': 'test', 'type_name': 'Test Case', 'type_p", '<sphinx_needs.views.NeedsView object at 0x72e6b3d7ad00>', '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 [%] 115.62482
Ratio build time [%] 0.00
Max run analysis

Max: 0.0000007399994501611218

args

['<sphinx.application.Sphinx object at 0x72e6caf09310>', 'None', '<sphinx_needs.views.NeedsView object at 0x72e6b3d7ad00>', '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.03056
Average [s] 0.00437
Min [s] 0.00005
Max [s] 0.01670
Min-Max spread [%] 31196.83558
Ratio build time [%] 0.03
Max run analysis

Max: 0.01670060200012813

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: 606

Function docs

None

filter_needs_and_parts
(filtering, internal)

Amount 37.00000
Overall [s] 0.05462
Average [s] 0.00148
Min [s] 0.00005
Max [s] 0.01261
Min-Max spread [%] 27047.82245
Ratio build time [%] 0.06
Max run analysis

Max: 0.012607530999957817

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: 628

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.03047
Average [s] 0.00002
Min [s] 0.00000
Max [s] 0.00010
Min-Max spread [%] 4311.61508
Ratio build time [%] 0.03
Max run analysis

Max: 0.00009873599992715754

args

["NeedItem(core={'id': 'EX_CARD_PROFILE', 'type': 'spec', 'type_name': 'Specificat", "NeedsSphinxConfig(from_toml='ubproject.toml', from_toml_table=[], schema_validat", '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/filter_common.py

Line: 797

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.00022
Average [s] 0.00011
Min [s] 0.00009
Max [s] 0.00013
Min-Max spread [%] 135.15980
Ratio build time [%] 0.00
Max run analysis

Max: 0.00012720700033241883

args

['<sphinx.application.Sphinx object at 0x72e6caf09310>', "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.09527
Average [s] 0.09527
Min [s] 0.09527
Max [s] 0.09527
Min-Max spread [%] 100.00000
Ratio build time [%] 0.10
Max run analysis

Max: 0.09526799599916558

args

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

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: 358

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.01077
Average [s] 0.00538
Min [s] 0.00104
Max [s] 0.00973
Min-Max spread [%] 936.48635
Ratio build time [%] 0.01
Max run analysis

Max: 0.009729138000693638

args

['<sphinx.application.Sphinx object at 0x72e6caf09310>', '<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.02961
Average [s] 0.00494
Min [s] 0.00067
Max [s] 0.01844
Min-Max spread [%] 2767.31091
Ratio build time [%] 0.03
Max run analysis

Max: 0.018441857999278

args

['<sphinx.application.Sphinx object at 0x72e6caf09310>', '<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.38654
Average [s] 0.19327
Min [s] 0.02960
Max [s] 0.35694
Min-Max spread [%] 1205.84900
Ratio build time [%] 0.41
Max run analysis

Max: 0.3569359949997306

args

['<sphinx.application.Sphinx object at 0x72e6caf09310>', '<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: 129

Function docs

None

process_needtables
(needtable, internal)

Amount 7.00000
Overall [s] 0.13891
Average [s] 0.01984
Min [s] 0.00128
Max [s] 0.09948
Min-Max spread [%] 7755.24120
Ratio build time [%] 0.15
Max run analysis

Max: 0.09947508299956098

args

['<sphinx.application.Sphinx object at 0x72e6caf09310>', '<document needs_has_interactive_table="1" source="/home/docs/checkouts/readthedo', '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: 304

Function docs


Replace all needtables nodes with a table of filtered nodes.

process_needuml
(needuml, internal)

Amount 3.00000
Overall [s] 0.00873
Average [s] 0.00291
Min [s] 0.00034
Max [s] 0.00475
Min-Max spread [%] 1409.92667
Ratio build time [%] 0.01
Max run analysis

Max: 0.004746926999359857

args

['<sphinx.application.Sphinx object at 0x72e6caf09310>', '<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: 639

Function docs

None

run
(need, internal)

Amount 188.00000
Overall [s] 0.11731
Average [s] 0.00062
Min [s] 0.00000
Max [s] 0.00276
Min-Max spread [%] 82110.45624
Ratio build time [%] 0.12
Max run analysis

Max: 0.0027597320004133508

args

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

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.00278
Average [s] 0.00007
Min [s] 0.00005
Max [s] 0.00020
Min-Max spread [%] 431.87881
Ratio build time [%] 0.00
Max run analysis

Max: 0.000196560999029316

args

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

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.00296
Average [s] 0.00296
Min [s] 0.00296
Max [s] 0.00296
Min-Max spread [%] 100.00000
Ratio build time [%] 0.00
Max run analysis

Max: 0.0029606179996335413

args

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

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

args

['<sphinx.application.Sphinx object at 0x72e6caf09310>', "NeedItem(core={'id': 'R_A6A4E', 'type': 'req', 'type_name': 'Requirement', 'type", '<sphinx_needs.views.NeedsView object at 0x72e6b3d7ad00>', '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