Sphinx-Needs Timing Measurement: Sphinx-Needs

Build Duration: 112.17s       Build timestamp: 2026-07-08T12:36:06.513285       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.5537848 0.0024945 0.0000918 0.2477842 222 269811.6 0.49
2 _build_needextract build_needextract internal 0.0059215 0.0014804 0.0006744 0.0018867 4 279.8 0.01
3 calc_sum dyn_func user 0.0067746 0.0016936 0.0000101 0.0063237 4 62853.1 0.01
4 check_linked_values dyn_func user 0.0003689 0.0000615 0.0000032 0.0003436 6 10704.4 0.00
5 copy dyn_func user 0.0042891 0.0002257 0.0000010 0.0042502 19 408676.7 0.00
6 echo dyn_func user 0.0000016 0.0000008 0.0000007 0.0000008 2 116.3 0.00
7 links_from_content dyn_func user 0.0002463 0.0001231 0.0001033 0.0001430 2 138.4 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.0253101 0.0036157 0.0000509 0.0120753 7 23736.2 0.02
10 filter_needs_and_parts filtering internal 0.0511901 0.0014219 0.0000077 0.0081180 36 105689.1 0.05
11 filter_single_need filtering internal 0.0319472 0.0000163 0.0000022 0.0000979 1961 4449.2 0.03
12 post_process_needs_data need_post_process internal 0.0928109 0.0928109 0.0928109 0.0928109 1 100.0 0.08
13 run need internal 0.1823081 0.0008599 0.0000057 0.0090200 212 159646.4 0.16
14 process_needflow_graphviz needflow_graphviz internal 0.0078598 0.0039299 0.0010949 0.0067649 2 617.9 0.01
15 process_needflow_plantuml needflow_plantuml internal 0.0254749 0.0042458 0.0005897 0.0145432 6 2466.2 0.02
16 run needflow internal 0.0022720 0.0000649 0.0000467 0.0001612 35 345.6 0.00
17 run needimport internal 0.0033107 0.0033107 0.0033107 0.0033107 1 100.0 0.00
18 process_needpie needpie internal 0.3628440 0.1814220 0.0305524 0.3322916 2 1087.6 0.32
19 process_needtables needtable internal 0.1430784 0.0204398 0.0013864 0.1019072 7 7350.7 0.13
20 process_needuml needuml internal 0.0087869 0.0029290 0.0003696 0.0048406 3 1309.8 0.01

Details

_build_needextract
(build_needextract, internal)

Amount 4.00000
Overall [s] 0.00592
Average [s] 0.00148
Min [s] 0.00067
Max [s] 0.00189
Min-Max spread [%] 279.75016
Ratio build time [%] 0.01
Max run analysis

Max: 0.0018866909995267633

args

['<sphinx.application.Sphinx object at 0x76be52f1aa90>', '<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/stable/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.55378
Average [s] 0.00249
Min [s] 0.00009
Max [s] 0.24778
Min-Max spread [%] 269811.63120
Ratio build time [%] 0.49
Max run analysis

Max: 0.24778420999973605

args

['<Need classes="[\'need\', \'need-test\']" ids="[\'T_0F2B7\']" refid="T_0F2B7"/>', "NeedItem(core={'id': 'T_0F2B7', 'type': 'test', 'type_name': 'Test Case', 'type_", '<sphinx.application.Sphinx object at 0x76be52f1aa90>']

kwargs

{'docname': 'directives/list2need'}
Show Meta Data

File: /home/docs/checkouts/readthedocs.org/user_builds/sphinx-needs/envs/stable/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.00677
Average [s] 0.00169
Min [s] 0.00001
Max [s] 0.00632
Min-Max spread [%] 62853.12301
Ratio build time [%] 0.01
Max run analysis

Max: 0.00632365299952653

args

['<sphinx.application.Sphinx object at 0x76be52f1aa90>', "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/stable/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 [%] 10704.39351
Ratio build time [%] 0.00
Max run analysis

Max: 0.0003436110000620829

args

['<sphinx.application.Sphinx object at 0x76be52f1aa90>', "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/stable/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.00429
Average [s] 0.00023
Min [s] 0.00000
Max [s] 0.00425
Min-Max spread [%] 408676.69500
Ratio build time [%] 0.00
Max run analysis

Max: 0.0042502409996814094

args

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

kwargs

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

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

Max: 0.0000008499991963617504

args

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

kwargs

{}
Show Meta Data

File: /home/docs/checkouts/readthedocs.org/user_builds/sphinx-needs/envs/stable/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.02531
Average [s] 0.00362
Min [s] 0.00005
Max [s] 0.01208
Min-Max spread [%] 23736.15322
Ratio build time [%] 0.02
Max run analysis

Max: 0.012075293000634701

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/stable/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.05119
Average [s] 0.00142
Min [s] 0.00001
Max [s] 0.00812
Min-Max spread [%] 105689.10013
Ratio build time [%] 0.05
Max run analysis

Max: 0.008117978999507613

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

Max: 0.00009792600030777976

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/stable/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.00025
Average [s] 0.00012
Min [s] 0.00010
Max [s] 0.00014
Min-Max spread [%] 138.37934
Ratio build time [%] 0.00
Max run analysis

Max: 0.00014296799963631202

args

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

Max: 0.09281091599950742

args

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

kwargs

{}
Show Meta Data

File: /home/docs/checkouts/readthedocs.org/user_builds/sphinx-needs/envs/stable/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.00786
Average [s] 0.00393
Min [s] 0.00109
Max [s] 0.00676
Min-Max spread [%] 617.86754
Ratio build time [%] 0.01
Max run analysis

Max: 0.006764938998458092

args

['<sphinx.application.Sphinx object at 0x76be52f1aa90>', '<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/stable/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.02547
Average [s] 0.00425
Min [s] 0.00059
Max [s] 0.01454
Min-Max spread [%] 2466.22881
Ratio build time [%] 0.02
Max run analysis

Max: 0.01454322800054797

args

['<sphinx.application.Sphinx object at 0x76be52f1aa90>', '<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/stable/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.36284
Average [s] 0.18142
Min [s] 0.03055
Max [s] 0.33229
Min-Max spread [%] 1087.61093
Ratio build time [%] 0.32
Max run analysis

Max: 0.3322915560002002

args

['<sphinx.application.Sphinx object at 0x76be52f1aa90>', '<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/stable/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.14308
Average [s] 0.02044
Min [s] 0.00139
Max [s] 0.10191
Min-Max spread [%] 7350.74446
Ratio build time [%] 0.13
Max run analysis

Max: 0.10190719300044293

args

['<sphinx.application.Sphinx object at 0x76be52f1aa90>', '<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/stable/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.00879
Average [s] 0.00293
Min [s] 0.00037
Max [s] 0.00484
Min-Max spread [%] 1309.77428
Ratio build time [%] 0.01
Max run analysis

Max: 0.004840559000513167

args

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

Line: 567

Function docs

none

run
(need, internal)

Amount 212.00000
Overall [s] 0.18231
Average [s] 0.00086
Min [s] 0.00001
Max [s] 0.00902
Min-Max spread [%] 159646.39929
Ratio build time [%] 0.16
Max run analysis

Max: 0.009020022000186145

args

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

kwargs

{}
Show Meta Data

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

Line: 65

Function docs

none

run
(needflow, internal)

Amount 35.00000
Overall [s] 0.00227
Average [s] 0.00006
Min [s] 0.00005
Max [s] 0.00016
Min-Max spread [%] 345.61336
Ratio build time [%] 0.00
Max run analysis

Max: 0.00016123899968079058

args

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

kwargs

{}
Show Meta Data

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

Max: 0.003310694999527186

args

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

kwargs

{}
Show Meta Data

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

args

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

kwargs

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

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