Sphinx-Needs Timing Measurement: Sphinx-Needs

Build Duration: 77.73s       Build timestamp: 2026-05-20T09:12:11.751008       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.4600110 0.0020721 0.0000581 0.2301458 222 396181.4 0.59
2 _build_needextract build_needextract internal 0.0043627 0.0010907 0.0004034 0.0014164 4 351.1 0.01
3 calc_sum dyn_func user 0.0049444 0.0012361 0.0000087 0.0045914 4 52828.8 0.01
4 check_linked_values dyn_func user 0.0003203 0.0000534 0.0000024 0.0002997 6 12538.2 0.00
5 copy dyn_func user 0.0036915 0.0001943 0.0000006 0.0036628 19 619760.6 0.00
6 echo dyn_func user 0.0000012 0.0000006 0.0000006 0.0000007 2 121.8 0.00
7 links_from_content dyn_func user 0.0001945 0.0000973 0.0000746 0.0001200 2 160.9 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.0182747 0.0026107 0.0000425 0.0102288 7 24084.9 0.02
10 filter_needs_and_parts filtering internal 0.0376511 0.0010459 0.0000054 0.0067101 36 124260.9 0.05
11 filter_single_need filtering internal 0.0251644 0.0000128 0.0000012 0.0000826 1961 7181.0 0.03
12 post_process_needs_data need_post_process internal 0.0702525 0.0702525 0.0702525 0.0702525 1 100.0 0.09
13 run need internal 0.1317193 0.0006213 0.0000037 0.0057339 212 156663.1 0.17
14 process_needflow_graphviz needflow_graphviz internal 0.0057506 0.0028753 0.0007703 0.0049803 2 646.5 0.01
15 process_needflow_plantuml needflow_plantuml internal 0.0186613 0.0031102 0.0005057 0.0101987 6 2016.6 0.02
16 run needflow internal 0.0017392 0.0000497 0.0000327 0.0001688 35 516.1 0.00
17 run needimport internal 0.0025803 0.0025803 0.0025803 0.0025803 1 100.0 0.00
18 process_needpie needpie internal 0.2674895 0.1337448 0.0218907 0.2455989 2 1121.9 0.34
19 process_needtables needtable internal 0.3061147 0.0437307 0.0010024 0.2770318 7 27638.2 0.39
20 process_needuml needuml internal 0.0058540 0.0019513 0.0001987 0.0032198 3 1620.3 0.01

Details

_build_needextract
(build_needextract, internal)

Amount 4.00000
Overall [s] 0.00436
Average [s] 0.00109
Min [s] 0.00040
Max [s] 0.00142
Min-Max spread [%] 351.11538
Ratio build time [%] 0.01
Max run analysis

Max: 0.0014164169997457066

args

['<sphinx.application.Sphinx object at 0x718d4b34bc50>', '<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/8.1.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.46001
Average [s] 0.00207
Min [s] 0.00006
Max [s] 0.23015
Min-Max spread [%] 396181.44100
Ratio build time [%] 0.59
Max run analysis

Max: 0.23014576100013073

args

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

kwargs

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

File: /home/docs/checkouts/readthedocs.org/user_builds/sphinx-needs/envs/8.1.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.00494
Average [s] 0.00124
Min [s] 0.00001
Max [s] 0.00459
Min-Max spread [%] 52828.84625
Ratio build time [%] 0.01
Max run analysis

Max: 0.004591355000229669

args

['<sphinx.application.Sphinx object at 0x718d4b34bc50>', "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.1.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.00032
Average [s] 0.00005
Min [s] 0.00000
Max [s] 0.00030
Min-Max spread [%] 12538.24168
Ratio build time [%] 0.00
Max run analysis

Max: 0.00029966400006742333

args

['<sphinx.application.Sphinx object at 0x718d4b34bc50>', "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.1.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.00369
Average [s] 0.00019
Min [s] 0.00000
Max [s] 0.00366
Min-Max spread [%] 619760.59170
Ratio build time [%] 0.00
Max run analysis

Max: 0.003662782999981573

args

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

kwargs

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

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

Max: 0.0000006700001904391684

args

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

kwargs

{}
Show Meta Data

File: /home/docs/checkouts/readthedocs.org/user_builds/sphinx-needs/envs/8.1.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.01827
Average [s] 0.00261
Min [s] 0.00004
Max [s] 0.01023
Min-Max spread [%] 24084.86478
Ratio build time [%] 0.02
Max run analysis

Max: 0.010228841999833094

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.1.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.03765
Average [s] 0.00105
Min [s] 0.00001
Max [s] 0.00671
Min-Max spread [%] 124260.92153
Ratio build time [%] 0.05
Max run analysis

Max: 0.006710090000069613

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/8.1.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.02516
Average [s] 0.00001
Min [s] 0.00000
Max [s] 0.00008
Min-Max spread [%] 7180.95578
Ratio build time [%] 0.03
Max run analysis

Max: 0.00008258099978775135

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.1.0/lib/python3.11/site-packages/sphinx_needs/filter_common.py

Line: 674

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.00007
Max [s] 0.00012
Min-Max spread [%] 160.90531
Ratio build time [%] 0.00
Max run analysis

Max: 0.00011997100000371574

args

['<sphinx.application.Sphinx object at 0x718d4b34bc50>', "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.1.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.07025
Average [s] 0.07025
Min [s] 0.07025
Max [s] 0.07025
Min-Max spread [%] 100.00000
Ratio build time [%] 0.09
Max run analysis

Max: 0.07025245899967558

args

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

kwargs

{}
Show Meta Data

File: /home/docs/checkouts/readthedocs.org/user_builds/sphinx-needs/envs/8.1.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.00575
Average [s] 0.00288
Min [s] 0.00077
Max [s] 0.00498
Min-Max spread [%] 646.50271
Ratio build time [%] 0.01
Max run analysis

Max: 0.004980269000043336

args

['<sphinx.application.Sphinx object at 0x718d4b34bc50>', '<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.1.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.01866
Average [s] 0.00311
Min [s] 0.00051
Max [s] 0.01020
Min-Max spread [%] 2016.56998
Ratio build time [%] 0.02
Max run analysis

Max: 0.010198722000041016

args

['<sphinx.application.Sphinx object at 0x718d4b34bc50>', '<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.1.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.26749
Average [s] 0.13374
Min [s] 0.02189
Max [s] 0.24560
Min-Max spread [%] 1121.93439
Ratio build time [%] 0.34
Max run analysis

Max: 0.2455988530000468

args

['<sphinx.application.Sphinx object at 0x718d4b34bc50>', '<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.1.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.30611
Average [s] 0.04373
Min [s] 0.00100
Max [s] 0.27703
Min-Max spread [%] 27638.17482
Ratio build time [%] 0.39
Max run analysis

Max: 0.27703179799982536

args

['<sphinx.application.Sphinx object at 0x718d4b34bc50>', '<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.1.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.00585
Average [s] 0.00195
Min [s] 0.00020
Max [s] 0.00322
Min-Max spread [%] 1620.33395
Ratio build time [%] 0.01
Max run analysis

Max: 0.003219797999918228

args

['<sphinx.application.Sphinx object at 0x718d4b34bc50>', '<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.1.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.13172
Average [s] 0.00062
Min [s] 0.00000
Max [s] 0.00573
Min-Max spread [%] 156663.08967
Ratio build time [%] 0.17
Max run analysis

Max: 0.005733868999868719

args

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

kwargs

{}
Show Meta Data

File: /home/docs/checkouts/readthedocs.org/user_builds/sphinx-needs/envs/8.1.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.00174
Average [s] 0.00005
Min [s] 0.00003
Max [s] 0.00017
Min-Max spread [%] 516.14796
Ratio build time [%] 0.00
Max run analysis

Max: 0.00016883199987205444

args

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

kwargs

{}
Show Meta Data

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

Max: 0.0025803210000958643

args

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

kwargs

{}
Show Meta Data

File: /home/docs/checkouts/readthedocs.org/user_builds/sphinx-needs/envs/8.1.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 0x718d4b34bc50>', "NeedItem(core={'id': 'R_A6A4E', 'type': 'req', 'type_name': 'Requirement', 'type", '<sphinx_needs.views.NeedsView object at 0x718d33ed3140>', 'arg_1', '[1, 2, 3]']

kwargs

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

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