Sphinx-Needs Timing Measurement: Sphinx-Needs

Build Duration: 117.94s       Build timestamp: 2026-07-01T14:40:12.295180       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.7333225 0.0033033 0.0000910 0.2270203 222 249514.0 0.62
2 _build_needextract build_needextract internal 0.0070955 0.0017739 0.0016441 0.0019588 4 119.1 0.01
3 calc_sum dyn_func user 0.0067965 0.0016991 0.0000101 0.0063392 4 63076.3 0.01
4 check_linked_values dyn_func user 0.0003670 0.0000612 0.0000032 0.0003414 6 10535.8 0.00
5 copy dyn_func user 0.0041228 0.0002170 0.0000008 0.0040879 19 492518.4 0.00
6 echo dyn_func user 0.0000015 0.0000007 0.0000007 0.0000008 2 108.6 0.00
7 links_from_content dyn_func user 0.0002023 0.0001012 0.0000789 0.0001234 2 156.3 0.00
8 test dyn_func user 0.0000067 0.0000067 0.0000067 0.0000067 1 100.0 0.00
9 filter_needs filtering internal 0.0250548 0.0035793 0.0000492 0.0158688 7 32258.3 0.02
10 filter_needs_and_parts filtering internal 0.2802855 0.0077857 0.0000097 0.2297726 36 2370989.7 0.24
11 filter_single_need filtering internal 0.0321861 0.0000164 0.0000022 0.0001057 1961 4780.8 0.03
12 post_process_needs_data need_post_process internal 0.0926939 0.0926939 0.0926939 0.0926939 1 100.0 0.08
13 run need internal 0.1618546 0.0007635 0.0000032 0.0062032 212 196926.9 0.14
14 process_needflow_graphviz needflow_graphviz internal 0.0078183 0.0039091 0.0011150 0.0067033 2 601.2 0.01
15 process_needflow_plantuml needflow_plantuml internal 0.0244011 0.0040668 0.0005940 0.0140290 6 2361.6 0.02
16 run needflow internal 0.0022027 0.0000629 0.0000434 0.0001622 35 373.4 0.00
17 run needimport internal 0.0032229 0.0032229 0.0032229 0.0032229 1 100.0 0.00
18 process_needpie needpie internal 0.5707904 0.2853952 0.2467965 0.3239939 2 131.3 0.48
19 process_needtables needtable internal 0.3539513 0.0505645 0.0013327 0.3134060 7 23517.3 0.30
20 process_needuml needuml internal 0.0082419 0.0027473 0.0002766 0.0045578 3 1647.6 0.01

Details

_build_needextract
(build_needextract, internal)

Amount 4.00000
Overall [s] 0.00710
Average [s] 0.00177
Min [s] 0.00164
Max [s] 0.00196
Min-Max spread [%] 119.14125
Ratio build time [%] 0.01
Max run analysis

Max: 0.001958848999493057

args

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

kwargs

{}
Show Meta Data

File: /home/docs/checkouts/readthedocs.org/user_builds/sphinx-needs/envs/8.2.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.73332
Average [s] 0.00330
Min [s] 0.00009
Max [s] 0.22702
Min-Max spread [%] 249514.00754
Ratio build time [%] 0.62
Max run analysis

Max: 0.22702032099914504

args

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

kwargs

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

File: /home/docs/checkouts/readthedocs.org/user_builds/sphinx-needs/envs/8.2.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.00680
Average [s] 0.00170
Min [s] 0.00001
Max [s] 0.00634
Min-Max spread [%] 63076.28774
Ratio build time [%] 0.01
Max run analysis

Max: 0.0063391669991688104

args

['<sphinx.application.Sphinx object at 0x7cbb5e85ad50>', "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/8.2.0/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.00037
Average [s] 0.00006
Min [s] 0.00000
Max [s] 0.00034
Min-Max spread [%] 10535.83240
Ratio build time [%] 0.00
Max run analysis

Max: 0.00034136100111936685

args

['<sphinx.application.Sphinx object at 0x7cbb5e85ad50>', "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/8.2.0/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.00412
Average [s] 0.00022
Min [s] 0.00000
Max [s] 0.00409
Min-Max spread [%] 492518.42353
Ratio build time [%] 0.00
Max run analysis

Max: 0.004087899998921785

args

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

kwargs

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

File: /home/docs/checkouts/readthedocs.org/user_builds/sphinx-needs/envs/8.2.0/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 [%] 108.60364
Ratio build time [%] 0.00
Max run analysis

Max: 0.0000007700000423938036

args

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

kwargs

{}
Show Meta Data

File: /home/docs/checkouts/readthedocs.org/user_builds/sphinx-needs/envs/8.2.0/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.02505
Average [s] 0.00358
Min [s] 0.00005
Max [s] 0.01587
Min-Max spread [%] 32258.28765
Ratio build time [%] 0.02
Max run analysis

Max: 0.015868819000388612

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/8.2.0/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.28029
Average [s] 0.00779
Min [s] 0.00001
Max [s] 0.22977
Min-Max spread [%] 2370989.65453
Ratio build time [%] 0.24
Max run analysis

Max: 0.22977262499989592

args

['<sphinx_needs.views.NeedsAndPartsListView object at 0x7cbb46536080>', "NeedsSphinxConfig(from_toml='ubproject.toml', from_toml_table=[], schema_validat", 'is_modified', 'None']

kwargs

{'location': '<NeedCount refdoc="directives/needextend" refdomain="" refexplicit="False" refta', 'append_warning': '', 'origin_docname': 'None'}
Show Meta Data

File: /home/docs/checkouts/readthedocs.org/user_builds/sphinx-needs/envs/8.2.0/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.03219
Average [s] 0.00002
Min [s] 0.00000
Max [s] 0.00011
Min-Max spread [%] 4780.81583
Ratio build time [%] 0.03
Max run analysis

Max: 0.00010565599950496107

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/8.2.0/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 [%] 156.29062
Ratio build time [%] 0.00
Max run analysis

Max: 0.00012336799954937305

args

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

Max: 0.0926939279997896

args

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

kwargs

{}
Show Meta Data

File: /home/docs/checkouts/readthedocs.org/user_builds/sphinx-needs/envs/8.2.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.00782
Average [s] 0.00391
Min [s] 0.00111
Max [s] 0.00670
Min-Max spread [%] 601.20909
Ratio build time [%] 0.01
Max run analysis

Max: 0.006703288998323842

args

['<sphinx.application.Sphinx object at 0x7cbb5e85ad50>', '<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/8.2.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.02440
Average [s] 0.00407
Min [s] 0.00059
Max [s] 0.01403
Min-Max spread [%] 2361.60051
Ratio build time [%] 0.02
Max run analysis

Max: 0.014029017000211752

args

['<sphinx.application.Sphinx object at 0x7cbb5e85ad50>', '<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/8.2.0/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.57079
Average [s] 0.28540
Min [s] 0.24680
Max [s] 0.32399
Min-Max spread [%] 131.27975
Ratio build time [%] 0.48
Max run analysis

Max: 0.32399386699944444

args

['<sphinx.application.Sphinx object at 0x7cbb5e85ad50>', '<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/8.2.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.35395
Average [s] 0.05056
Min [s] 0.00133
Max [s] 0.31341
Min-Max spread [%] 23517.30784
Ratio build time [%] 0.30
Max run analysis

Max: 0.31340599000031943

args

['<sphinx.application.Sphinx object at 0x7cbb5e85ad50>', '<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/8.2.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.00824
Average [s] 0.00275
Min [s] 0.00028
Max [s] 0.00456
Min-Max spread [%] 1647.62389
Ratio build time [%] 0.01
Max run analysis

Max: 0.004557788999591139

args

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

Line: 567

Function docs

none

run
(need, internal)

Amount 212.00000
Overall [s] 0.16185
Average [s] 0.00076
Min [s] 0.00000
Max [s] 0.00620
Min-Max spread [%] 196926.93120
Ratio build time [%] 0.14
Max run analysis

Max: 0.006203199000083259

args

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

kwargs

{}
Show Meta Data

File: /home/docs/checkouts/readthedocs.org/user_builds/sphinx-needs/envs/8.2.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.00220
Average [s] 0.00006
Min [s] 0.00004
Max [s] 0.00016
Min-Max spread [%] 373.40653
Ratio build time [%] 0.00
Max run analysis

Max: 0.00016221899932133965

args

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

kwargs

{}
Show Meta Data

File: /home/docs/checkouts/readthedocs.org/user_builds/sphinx-needs/envs/8.2.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.00322
Average [s] 0.00322
Min [s] 0.00322
Max [s] 0.00322
Min-Max spread [%] 100.00000
Ratio build time [%] 0.00
Max run analysis

Max: 0.0032229370008280966

args

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

kwargs

{}
Show Meta Data

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

args

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

kwargs

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

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