Sphinx-Needs Timing Measurement: Sphinx-Needs

Build Duration: 107.23s       Build timestamp: 2026-07-08T12:30:35.374043       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.5471832 0.0024648 0.0000822 0.2495212 222 303657.1 0.51
2 _build_needextract build_needextract internal 0.0054845 0.0013711 0.0006210 0.0016901 4 272.2 0.01
3 calc_sum dyn_func user 0.0064483 0.0016121 0.0000098 0.0060015 4 61428.2 0.01
4 check_linked_values dyn_func user 0.0000824 0.0000137 0.0000030 0.0000593 6 2003.1 0.00
5 copy dyn_func user 0.0040508 0.0002132 0.0000009 0.0040150 19 436414.7 0.00
6 echo dyn_func user 0.0000014 0.0000007 0.0000006 0.0000008 2 127.4 0.00
7 links_from_content dyn_func user 0.0002046 0.0001023 0.0000814 0.0001233 2 151.5 0.00
8 test dyn_func user 0.0000069 0.0000069 0.0000069 0.0000069 1 100.0 0.00
9 filter_needs filtering internal 0.0251852 0.0035979 0.0000747 0.0160475 7 21470.6 0.02
10 filter_needs_and_parts filtering internal 0.0489899 0.0013608 0.0000115 0.0121320 36 105587.4 0.05
11 filter_single_need filtering internal 0.0306392 0.0000156 0.0000021 0.0000992 1961 4656.9 0.03
12 post_process_needs_data need_post_process internal 0.0875207 0.0875207 0.0875207 0.0875207 1 100.0 0.08
13 run need internal 0.1598917 0.0007542 0.0000036 0.0061654 212 168914.6 0.15
14 process_needflow_graphviz needflow_graphviz internal 0.0077138 0.0038569 0.0010922 0.0066216 2 606.2 0.01
15 process_needflow_plantuml needflow_plantuml internal 0.0243844 0.0040641 0.0005668 0.0140616 6 2480.9 0.02
16 run needflow internal 0.0021845 0.0000624 0.0000437 0.0001510 35 345.9 0.00
17 run needimport internal 0.0032066 0.0032066 0.0032066 0.0032066 1 100.0 0.00
18 process_needpie needpie internal 0.3459060 0.1729530 0.0304377 0.3154683 2 1036.4 0.32
19 process_needtables needtable internal 0.3489546 0.0498507 0.0012607 0.3101253 7 24599.6 0.33
20 process_needuml needuml internal 0.0083779 0.0027926 0.0002554 0.0047070 3 1842.9 0.01

Details

_build_needextract
(build_needextract, internal)

Amount 4.00000
Overall [s] 0.00548
Average [s] 0.00137
Min [s] 0.00062
Max [s] 0.00169
Min-Max spread [%] 272.15160
Ratio build time [%] 0.01
Max run analysis

Max: 0.0016901050000797113

args

['<sphinx.application.Sphinx object at 0x70d5be377010>', '<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/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 222.00000
Overall [s] 0.54718
Average [s] 0.00246
Min [s] 0.00008
Max [s] 0.24952
Min-Max spread [%] 303657.14835
Ratio build time [%] 0.51
Max run analysis

Max: 0.24952115199994296

args

['<Need classes="need need-req" ids="ID123" refid="ID123"><paragraph>Our users nee', "NeedItem(core={'id': 'ID123', 'type': 'req', 'type_name': 'Requirement', 'type_p", '<sphinx.application.Sphinx object at 0x70d5be377010>']

kwargs

{'docname': 'directives/need'}
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: 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.00645
Average [s] 0.00161
Min [s] 0.00001
Max [s] 0.00600
Min-Max spread [%] 61428.20939
Ratio build time [%] 0.01
Max run analysis

Max: 0.006001535999985208

args

['<sphinx.application.Sphinx object at 0x70d5be377010>', "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/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**

.. 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.00008
Average [s] 0.00001
Min [s] 0.00000
Max [s] 0.00006
Min-Max spread [%] 2003.07428
Ratio build time [%] 0.00
Max run analysis

Max: 0.00005929100007051602

args

['<sphinx.application.Sphinx object at 0x70d5be377010>', "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/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**

.. 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.00405
Average [s] 0.00021
Min [s] 0.00000
Max [s] 0.00402
Min-Max spread [%] 436414.65045
Ratio build time [%] 0.00
Max run analysis

Max: 0.004015014000060546

args

['<sphinx.application.Sphinx object at 0x70d5be377010>', "NeedItem(core={'id': 'copy_4', 'type': 'test', 'type_name': 'Test Case', 'type_p", '<sphinx_needs.views.NeedsView object at 0x70d5a7e721c0>', '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

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

Max: 0.0000007900000582594657

args

['<sphinx.application.Sphinx object at 0x70d5be377010>', 'None', '<sphinx_needs.views.NeedsView object at 0x70d5a7e721c0>', '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.

.. need-example::

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

filter_needs
(filtering, internal)

Amount 7.00000
Overall [s] 0.02519
Average [s] 0.00360
Min [s] 0.00007
Max [s] 0.01605
Min-Max spread [%] 21470.55072
Ratio build time [%] 0.02
Max run analysis

Max: 0.016047519000039756

args

["dict_values([NeedItem(core={'id': 'EXTRA_REQ_001', 'type': 'req', '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: 493

Function docs

none

filter_needs_and_parts
(filtering, internal)

Amount 36.00000
Overall [s] 0.04899
Average [s] 0.00136
Min [s] 0.00001
Max [s] 0.01213
Min-Max spread [%] 105587.35508
Ratio build time [%] 0.05
Max run analysis

Max: 0.012131986999975197

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': '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: 515

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 1961.00000
Overall [s] 0.03064
Average [s] 0.00002
Min [s] 0.00000
Max [s] 0.00010
Min-Max spread [%] 4656.90144
Ratio build time [%] 0.03
Max run analysis

Max: 0.00009919199987962202

args

["NeedItem(core={'id': 'EXTRA_REQ_001', 'type': 'req', 'type_name': 'Requirement',", "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: 684

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

Max: 0.00012327300009928877

args

['<sphinx.application.Sphinx object at 0x70d5be377010>', "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/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.08752
Average [s] 0.08752
Min [s] 0.08752
Max [s] 0.08752
Min-Max spread [%] 100.00000
Ratio build time [%] 0.08
Max run analysis

Max: 0.08752074399990306

args

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

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.00771
Average [s] 0.00386
Min [s] 0.00109
Max [s] 0.00662
Min-Max spread [%] 606.24768
Ratio build time [%] 0.01
Max run analysis

Max: 0.006621612999879289

args

['<sphinx.application.Sphinx object at 0x70d5be377010>', '<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.02438
Average [s] 0.00406
Min [s] 0.00057
Max [s] 0.01406
Min-Max spread [%] 2480.90435
Ratio build time [%] 0.02
Max run analysis

Max: 0.014061616999924809

args

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

Function docs

none

process_needpie
(needpie, internal)

Amount 2.00000
Overall [s] 0.34591
Average [s] 0.17295
Min [s] 0.03044
Max [s] 0.31547
Min-Max spread [%] 1036.43783
Ratio build time [%] 0.32
Max run analysis

Max: 0.3154683049999676

args

['<sphinx.application.Sphinx object at 0x70d5be377010>', '<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.34895
Average [s] 0.04985
Min [s] 0.00126
Max [s] 0.31013
Min-Max spread [%] 24599.58578
Ratio build time [%] 0.33
Max run analysis

Max: 0.3101252559999921

args

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

Function docs


Replace all needtables nodes with a table of filtered nodes.

process_needuml
(needuml, internal)

Amount 3.00000
Overall [s] 0.00838
Average [s] 0.00279
Min [s] 0.00026
Max [s] 0.00471
Min-Max spread [%] 1842.88494
Ratio build time [%] 0.01
Max run analysis

Max: 0.004707023000037225

args

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

Function docs

none

run
(need, internal)

Amount 212.00000
Overall [s] 0.15989
Average [s] 0.00075
Min [s] 0.00000
Max [s] 0.00617
Min-Max spread [%] 168914.55600
Ratio build time [%] 0.15
Max run analysis

Max: 0.006165381000073467

args

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

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 35.00000
Overall [s] 0.00218
Average [s] 0.00006
Min [s] 0.00004
Max [s] 0.00015
Min-Max spread [%] 345.92428
Ratio build time [%] 0.00
Max run analysis

Max: 0.0001510340000550059

args

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

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

Function docs

none

run
(needimport, internal)

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

Max: 0.0032066039998426277

args

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

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

args

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

.. need-example::

.. req:: test requirement

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

:return: single test string