Sphinx-Needs Timing Measurement: Sphinx-Needs

Build Duration: 137.47s       Build timestamp: 2026-09-05T10:54:30.012151       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.2991176 0.0013353 0.0000728 0.0035827 224 4919.6 0.22
2 _build_needextract build_needextract internal 0.0056278 0.0014069 0.0005715 0.0017607 4 308.1 0.00
3 calc_sum dyn_func user 0.0067146 0.0016786 0.0000085 0.0062577 4 73275.3 0.00
4 check_linked_values dyn_func user 0.0004311 0.0000718 0.0000032 0.0004059 6 12882.7 0.00
5 copy dyn_func user 0.0038686 0.0002036 0.0000010 0.0038299 19 390808.6 0.00
6 echo dyn_func user 0.0000014 0.0000007 0.0000007 0.0000007 2 100.0 0.00
7 links_from_content dyn_func user 0.0001919 0.0000959 0.0000776 0.0001142 2 147.2 0.00
8 test dyn_func user 0.0000070 0.0000070 0.0000070 0.0000070 1 100.0 0.00
9 filter_needs filtering internal 0.0253804 0.0036258 0.0000535 0.0120025 7 22449.7 0.02
10 filter_needs_and_parts filtering internal 0.0505511 0.0013662 0.0000465 0.0080261 37 17244.5 0.04
11 filter_single_need filtering internal 0.0302456 0.0000153 0.0000023 0.0001130 1978 4828.5 0.02
12 post_process_needs_data need_post_process internal 0.0928769 0.0928769 0.0928769 0.0928769 1 100.0 0.07
13 run need internal 0.1163665 0.0006190 0.0000031 0.0024218 188 77375.1 0.08
14 process_needflow_graphviz needflow_graphviz internal 0.0115657 0.0057828 0.0010807 0.0104849 2 970.2 0.01
15 process_needflow_plantuml needflow_plantuml internal 0.0295171 0.0049195 0.0007415 0.0184142 6 2483.5 0.02
16 run needflow internal 0.0027220 0.0000664 0.0000451 0.0001787 41 396.1 0.00
17 run needimport internal 0.0029302 0.0029302 0.0029302 0.0029302 1 100.0 0.00
18 process_needpie needpie internal 0.3902139 0.1951070 0.0303860 0.3598279 2 1184.2 0.28
19 process_needtables needtable internal 0.1380774 0.0197253 0.0011982 0.0984295 7 8214.9 0.10
20 process_needuml needuml internal 0.0084721 0.0028240 0.0003193 0.0046629 3 1460.4 0.01

Details

_build_needextract
(build_needextract, internal)

Amount 4.00000
Overall [s] 0.00563
Average [s] 0.00141
Min [s] 0.00057
Max [s] 0.00176
Min-Max spread [%] 308.10031
Ratio build time [%] 0.00
Max run analysis

Max: 0.0017607440001938812

args

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

Function docs

Creates a new need representation.

build_need_repr
(build_need_repr, internal)

Amount 224.00000
Overall [s] 0.29912
Average [s] 0.00134
Min [s] 0.00007
Max [s] 0.00358
Min-Max spread [%] 4919.58806
Ratio build time [%] 0.22
Max run analysis

Max: 0.0035826900000301976

args

['<Need classes="need need-req" ids="EX_DEBUG" refid="EX_DEBUG"><paragraph>This is', "NeedItem(core={'id': 'EX_DEBUG', 'type': 'req', 'type_name': 'Requirement', 'typ", '<sphinx.application.Sphinx object at 0x7698538016d0>']

kwargs

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

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

Line: 44

Function docs

Create an output representation for a need.

:param layout: Override layout from need data / config
:param style: Override style from need data / config
:param docname: Override docname from need data / config

The created table will have the following docutils structure::

- table
-- tgroup
--- colspec (partial used)
--- thead (not used)
--- tbody
---- row
----- entry
------ custom layout nodes

The level structure must be kept, otherwise docutils can not handle it!

calc_sum
(dyn_func, user)

Amount 4.00000
Overall [s] 0.00671
Average [s] 0.00168
Min [s] 0.00001
Max [s] 0.00626
Min-Max spread [%] 73275.25801
Ratio build time [%] 0.00
Max run analysis

Max: 0.006257707000031587

args

['<sphinx.application.Sphinx object at 0x7698538016d0>', "NeedItem(core={'id': 'R_96D5E', 'type': 'req', 'type_name': 'Requirement', 'type", "{'EX_CARD_PROFILE': NeedItem(core={'id': 'EX_CARD_PROFILE', 'type': 'spec', 'typ", 'hours', 'hours is not None and hours > 10']

kwargs

{}
Show Meta Data

File: /home/docs/checkouts/readthedocs.org/user_builds/sphinx-needs/envs/latest/lib/python3.11/site-packages/sphinx_needs/functions/common.py

Line: 304

Function docs


Sums the values of a given option in filtered needs up to single number.

Useful e.g. for calculating the amount of needed hours for implementation of all linked
specification needs.


**Input data**

.. spec:: Do this
:id: sum_input_1
:hours: 7
:collapse: False

.. spec:: Do that
:id: sum_input_2
:hours: 15
:collapse: False

.. spec:: Do too much
:id: sum_input_3
:hours: 110
:collapse: False

**Example 2**

.. syntax-example::

.. req:: Result 1
:amount: [[calc_sum("hours")]]
:collapse: False


**Example 2**

.. syntax-example::

.. req:: Result 2
:amount: [[calc_sum("hours", "hours is not None and hours > 10")]]
:collapse: False

**Example 3**

.. syntax-example::

.. req:: Result 3
:links: sum_input_1; sum_input_3
:amount: [[calc_sum("hours", links_only="True")]]
:collapse: False

**Example 4**

.. syntax-example::

.. req:: Result 4
:links: sum_input_1; sum_input_3
:amount: [[calc_sum("hours", "hours is not None and hours > 10", "True")]]
:collapse: False

:param option: Options, from which the numbers shall be taken
:param filter: Filter string, which all needs must passed to get their value added.
:param links_only: If "True", only linked needs are taken into account.

:return: A float number

check_linked_values
(dyn_func, user)

Amount 6.00000
Overall [s] 0.00043
Average [s] 0.00007
Min [s] 0.00000
Max [s] 0.00041
Min-Max spread [%] 12882.70349
Ratio build time [%] 0.00
Max run analysis

Max: 0.00040593399990029866

args

['<sphinx.application.Sphinx object at 0x7698538016d0>', "NeedItem(core={'id': 'S_78442', 'type': 'spec', 'type_name': 'Specification', 't", "{'EX_CARD_PROFILE': NeedItem(core={'id': 'EX_CARD_PROFILE', 'type': 'spec', 'typ", 'progress', 'status', 'in progress', 'type == "req" ']

kwargs

{}
Show Meta Data

File: /home/docs/checkouts/readthedocs.org/user_builds/sphinx-needs/envs/latest/lib/python3.11/site-packages/sphinx_needs/functions/common.py

Line: 175

Function docs


Returns a specific value, if for all linked needs a given option has a given value.

The linked needs can be filtered by using the ``filter`` option.

If ``one_hit`` is set to True, only one linked need must have a positive match for the searched value.

**Examples**

**Needs used as input data**

.. syntax-example::

.. req:: Input A
:id: clv_A
:status: in progress

.. req:: Input B
:id: clv_B
:status: in progress

.. spec:: Input C
:id: clv_C
:status: closed

**Example 1: Positive check**

Status gets set to *progress*.

.. syntax-example::

.. spec:: result 1: Positive check
:links: clv_A, clv_B
:status: [[check_linked_values('progress', 'status', 'in progress' )]]
:collapse: False

**Example 2: Negative check**

Status gets not set to *progress*, because status of linked need *clv_C* does not match *"in progress"*.

.. syntax-example::

.. spec:: result 2: Negative check
:links: clv_A, clv_B, clv_C
:status: [[check_linked_values('progress', 'status', 'in progress' )]]
:collapse: False

**Example 3: Positive check thanks of used filter**

status gets set to *progress*, because linked need *clv_C* is not part of the filter.

.. syntax-example::

.. spec:: result 3: Positive check thanks of used filter
:links: clv_A, clv_B, clv_C
:status: [[check_linked_values('progress', 'status', 'in progress', 'type == "req" ' )]]
:collapse: False

**Example 4: Positive check thanks of one_hit option**

Even *clv_C* has not the searched status, status gets anyway set to *progress*.
That's because ``one_hit`` is used so that only one linked need must have the searched
value.

.. syntax-example::

.. spec:: result 4: Positive check thanks of one_hit option
:links: clv_A, clv_B, clv_C
:status: [[check_linked_values('progress', 'status', 'in progress', one_hit=True )]]
:collapse: False

**Result 5: Two checks and a joint status**
Two checks are performed and both are positive. So their results get joined.

.. syntax-example::

.. spec:: result 5: Two checks and a joint status
:links: clv_A, clv_B, clv_C
:status: [[check_linked_values('progress', 'status', 'in progress', one_hit=True )]] [[check_linked_values('closed', 'status', 'closed', one_hit=True )]]
:collapse: False

:param result: value, which gets returned if all linked needs have parsed the checks
:param search_option: option name, which is used n linked needs for the search
:param search_value: value, which an option of a linked need must match
:param filter_string: Checks are only performed on linked needs, which pass the defined filter
:param one_hit: If True, only one linked need must have a positive check
:return: result, if all checks are positive

copy
(dyn_func, user)

Amount 19.00000
Overall [s] 0.00387
Average [s] 0.00020
Min [s] 0.00000
Max [s] 0.00383
Min-Max spread [%] 390808.63547
Ratio build time [%] 0.00
Max run analysis

Max: 0.003829924999990908

args

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

kwargs

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

File: /home/docs/checkouts/readthedocs.org/user_builds/sphinx-needs/envs/latest/lib/python3.11/site-packages/sphinx_needs/functions/common.py

Line: 77

Function docs


Copies the value of one need option to another

.. syntax-example::

.. req:: copy-example
:id: copy_1
:tags: tag_1, tag_2, tag_3
:status: open

.. spec:: copy-example implementation
:id: copy_2
:status: [[copy("status", "copy_1")]]
:links: copy_1
:comment: [[copy("id")]]

Copies status of ``copy_1`` to own status.
Sets also a comment, which copies the id of own need.

.. test:: test of specification and requirement
:id: copy_3
:links: copy_2; [[copy('links', 'copy_2')]]
:tags: [[copy('tags', 'copy_1')]]

Set own link to ``copy_2`` and also copies all links from it.

Also copies all tags from copy_1.

If the filter_string needs to compare a value from the current need and the value is unknown yet,
you can reference the valued field by using ``current_need["my_field"]`` inside the filter string.
Small example::

.. test:: test of current_need value
:id: copy_4

The following copy command copies the title of the first need found under the same highest
section (headline):

:ndf:`copy('title', filter='current_need["sections"][-1]==sections[-1]')`

.. test:: test of current_need value
:id: copy_4

The following copy command copies the title of the first need found under the same highest
section (headline):

:ndf:`copy('title', filter='current_need["sections"][-1]==sections[-1]')`

:param option: Name of the option to copy
:param need_id: id of the need, which contains the source option. If None, current need is taken
:param upper: Is set to True, copied value will be uppercase
:param lower: Is set to True, copied value will be lowercase
:param filter: :ref:`filter_string`, which first result is used as copy source.
:return: string of copied need option

echo
(dyn_func, user)

Amount 2.00000
Overall [s] 0.00000
Average [s] 0.00000
Min [s] 0.00000
Max [s] 0.00000
Min-Max spread [%] 100.00003
Ratio build time [%] 0.00
Max run analysis

Max: 0.0000007000001005508238

args

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

kwargs

{}
Show Meta Data

File: /home/docs/checkouts/readthedocs.org/user_builds/sphinx-needs/envs/latest/lib/python3.11/site-packages/sphinx_needs/functions/common.py

Line: 55

Function docs


.. versionadded:: 0.6.3

Just returns the given string back.
Mostly useful for tests.

.. syntax-example::

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

filter_needs
(filtering, internal)

Amount 7.00000
Overall [s] 0.02538
Average [s] 0.00363
Min [s] 0.00005
Max [s] 0.01200
Min-Max spread [%] 22449.67639
Ratio build time [%] 0.02
Max run analysis

Max: 0.012002495000160707

args

["dict_values([NeedItem(core={'id': 'EX_CARD_PROFILE', 'type': 'spec', 'type_name'", "NeedsSphinxConfig(from_toml='ubproject.toml', from_toml_table=[], schema_validat", 'c.this_doc() and status is None', 'None']

kwargs

{'location': "('directives/needextend', 108)", 'append_warning': '', 'origin_docname': 'directives/needextend'}
Show Meta Data

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

Line: 606

Function docs

None

filter_needs_and_parts
(filtering, internal)

Amount 37.00000
Overall [s] 0.05055
Average [s] 0.00137
Min [s] 0.00005
Max [s] 0.00803
Min-Max spread [%] 17244.50721
Ratio build time [%] 0.04
Max run analysis

Max: 0.008026110999935554

args

["dict_values([NeedItem(core={'id': 'EX_CARD_PROFILE', 'type': 'spec', 'type_name'", "NeedsSphinxConfig(from_toml='ubproject.toml', from_toml_table=[], schema_validat"]

kwargs

{'filter_string': 'c.this_doc() and status is None', 'current_need': 'None', 'location': "('directives/needextend', 108)", 'append_warning': '', 'origin_docname': 'directives/needextend'}
Show Meta Data

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

Line: 628

Function docs


Filters given needs based on a given filter string.
Returns all needs, which pass the given filter.

:param needs: list of needs, which shall be filtered
:param config: NeedsSphinxConfig object
:param filter_string: strings, which gets evaluated against each need
:param current_need: current need, which uses the filter.
:param location: source location for error reporting (docname, line number)
:param append_warning: additional text to append to any failed filter warning

:return: list of found needs

filter_single_need
(filtering, internal)

Amount 1978.00000
Overall [s] 0.03025
Average [s] 0.00002
Min [s] 0.00000
Max [s] 0.00011
Min-Max spread [%] 4828.50420
Ratio build time [%] 0.02
Max run analysis

Max: 0.00011298699996586947

args

["NeedItem(core={'id': 'EX_CARD_PROFILE', 'type': 'spec', 'type_name': 'Specificat", "NeedsSphinxConfig(from_toml='ubproject.toml', from_toml_table=[], schema_validat", 'hours is not None and hours > 10']

kwargs

{}
Show Meta Data

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

Line: 797

Function docs

Checks if a single need/need_part passes a filter_string.

:param need: the data for a single need
:param config: NeedsSphinxConfig object
:param filter_string: string, which is used as input for eval()
:param needs: list of all needs
:param current_need: set the current_need in the filter context as this, otherwise the need itself
:param filter_compiled: An already compiled filter_string to save time
:param origin_docname: The origin docname that the filter was called from, if any

:return: True, if need passes the filter_string, else False

links_from_content
(dyn_func, user)

Amount 2.00000
Overall [s] 0.00019
Average [s] 0.00010
Min [s] 0.00008
Max [s] 0.00011
Min-Max spread [%] 147.19706
Ratio build time [%] 0.00
Max run analysis

Max: 0.00011424699982853781

args

['<sphinx.application.Sphinx object at 0x7698538016d0>', "NeedItem(core={'id': 'CON_SPEC_1', 'type': 'spec', 'type_name': 'Specification',", "{'EX_CARD_PROFILE': NeedItem(core={'id': 'EX_CARD_PROFILE', 'type': 'spec', 'typ"]

kwargs

{}
Show Meta Data

File: /home/docs/checkouts/readthedocs.org/user_builds/sphinx-needs/envs/latest/lib/python3.11/site-packages/sphinx_needs/functions/common.py

Line: 418

Function docs


Extracts need references from the content of a need.

All need-links set by using ``:need:`NEED_ID``` are extracted
from the parsed doctree node of the source need.

Same links are only added once.

.. versionchanged:: 8.0.0

Previously used a regex on raw RST source text to extract ``:need:`` references.
Now walks the parsed doctree, which correctly handles custom titles
(e.g. ``:need:`My Title ```) and nested content.

This function requires the source need to have a stored doctree node.
It will emit a warning and return an empty list for needs without a
stored node (e.g. external needs or need parts).

Example:

.. req:: Requirement 1
:id: CON_REQ_1

.. req:: Requirement 2
:id: CON_REQ_2

.. spec:: Test spec
:id: CON_SPEC_1
:links: [[links_from_content()]]

This specification cares about the realisation of:

* :need:`CON_REQ_1`
* :need:`My need `

.. spec:: Test spec 2
:id: CON_SPEC_2
:links: [[links_from_content('CON_SPEC_1')]]

Links retrieved from content of :need:`CON_SPEC_1`

Used code of **CON_SPEC_1**::

.. spec:: Test spec
:id: CON_SPEC_1
:links: [[links_from_content()]]

This specification cares about the realisation of:

* :need:`CON_REQ_1`
* :need:`CON_REQ_2`

.. spec:: Test spec 2
:id: CON_SPEC_2
:links: [[links_from_content('CON_SPEC_1')]]

Links retrieved from content of :need:`CON_SPEC_1`

:param need_id: ID of need, which provides the content. If not set, current need is used.
:param filter: :ref:`filter_string`, which a found need-link must pass.
:return: List of linked need-ids in content

post_process_needs_data
(need_post_process, internal)

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

Max: 0.0928768639998907

args

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

kwargs

{}
Show Meta Data

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

Line: 358

Function docs

In-place post-processing of needs data.

This should be called after all needs (and extend) data has been collected.

This function is idempotent;
it will only be run on the first call, and will not be run again.

After this function has been run, one should assume that the needs data is finalised,
and so in principle should be treated as read-only.

process_needflow_graphviz
(needflow_graphviz, internal)

Amount 2.00000
Overall [s] 0.01157
Average [s] 0.00578
Min [s] 0.00108
Max [s] 0.01048
Min-Max spread [%] 970.18601
Ratio build time [%] 0.01
Max run analysis

Max: 0.010484936000011658

args

['<sphinx.application.Sphinx object at 0x7698538016d0>', '<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.02952
Average [s] 0.00492
Min [s] 0.00074
Max [s] 0.01841
Min-Max spread [%] 2483.52588
Ratio build time [%] 0.02
Max run analysis

Max: 0.01841420199980348

args

['<sphinx.application.Sphinx object at 0x7698538016d0>', '<document source="/home/docs/checkouts/readthedocs.org/user_builds/sphinx-needs/', 'directives/needflow', '[<NeedflowPlantuml: >, <NeedflowPlantuml: >, <NeedflowPlantuml: >, <NeedflowPlan']

kwargs

{}
Show Meta Data

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

Line: 218

Function docs

None

process_needpie
(needpie, internal)

Amount 2.00000
Overall [s] 0.39021
Average [s] 0.19511
Min [s] 0.03039
Max [s] 0.35983
Min-Max spread [%] 1184.18800
Ratio build time [%] 0.28
Max run analysis

Max: 0.3598278740000751

args

['<sphinx.application.Sphinx object at 0x7698538016d0>', '<document source="/home/docs/checkouts/readthedocs.org/user_builds/sphinx-needs/', 'directives/needpie', '[<Needpie: >, <Needpie: >, <Needpie: >, <Needpie: >, <Needpie: >, <Needpie: >, <']

kwargs

{}
Show Meta Data

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

Line: 129

Function docs

None

process_needtables
(needtable, internal)

Amount 7.00000
Overall [s] 0.13808
Average [s] 0.01973
Min [s] 0.00120
Max [s] 0.09843
Min-Max spread [%] 8214.91737
Ratio build time [%] 0.10
Max run analysis

Max: 0.0984294970000974

args

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

Function docs


Replace all needtables nodes with a table of filtered nodes.

process_needuml
(needuml, internal)

Amount 3.00000
Overall [s] 0.00847
Average [s] 0.00282
Min [s] 0.00032
Max [s] 0.00466
Min-Max spread [%] 1460.40690
Ratio build time [%] 0.01
Max run analysis

Max: 0.004662904000042545

args

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

Function docs

None

run
(need, internal)

Amount 188.00000
Overall [s] 0.11637
Average [s] 0.00062
Min [s] 0.00000
Max [s] 0.00242
Min-Max spread [%] 77375.14703
Ratio build time [%] 0.08
Max run analysis

Max: 0.0024218420001034247

args

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

kwargs

{}
Show Meta Data

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

Line: 65

Function docs

None

run
(needflow, internal)

Amount 41.00000
Overall [s] 0.00272
Average [s] 0.00007
Min [s] 0.00005
Max [s] 0.00018
Min-Max spread [%] 396.11556
Ratio build time [%] 0.00
Max run analysis

Max: 0.00017865999984678638

args

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

kwargs

{}
Show Meta Data

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

Line: 89

Function docs

None

run
(needimport, internal)

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

Max: 0.002930182000000059

args

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

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

args

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

kwargs

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

File: /home/docs/checkouts/readthedocs.org/user_builds/sphinx-needs/envs/latest/lib/python3.11/site-packages/sphinx_needs/functions/common.py

Line: 31

Function docs


Test function for dynamic functions in sphinx needs.

Collects every given args and kwargs and returns a single string, which contains their values/keys.

.. syntax-example::

.. req:: test requirement

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

:return: single test string