Sphinx-Needs Timing Measurement: Sphinx-Needs

Build Duration: 70.77s       Build timestamp: 2026-03-19T13:31:25.737113       Elements: 19

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.7624399 0.0034344 0.0014900 0.1917598 222 12869.6 1.08
2 _build_needextract build_needextract internal 0.0104591 0.0026148 0.0018705 0.0029925 4 160.0 0.01
3 calc_sum dyn_func user 0.0039642 0.0009910 0.0000064 0.0034598 4 54143.3 0.01
4 check_linked_values dyn_func user 0.0003100 0.0000517 0.0000013 0.0002981 6 22411.4 0.00
5 copy dyn_func user 0.0011168 0.0000532 0.0000004 0.0010969 21 304707.4 0.00
6 echo dyn_func user 0.0000016 0.0000008 0.0000006 0.0000011 2 191.1 0.00
7 links_from_content dyn_func user 0.0001842 0.0000921 0.0000065 0.0001777 2 2750.8 0.00
8 test dyn_func user 0.0000056 0.0000056 0.0000056 0.0000056 1 100.0 0.00
9 filter_needs filtering internal 0.0346418 0.0009898 0.0000175 0.0086076 35 49101.9 0.05
10 filter_single_need filtering internal 0.0217152 0.0000047 0.0000018 0.0001594 4608 8613.6 0.03
11 post_process_needs_data need_post_process internal 0.0600523 0.0600523 0.0600523 0.0600523 1 100.0 0.08
12 run need internal 0.0886128 0.0004180 0.0000008 0.0038942 212 480762.4 0.13
13 process_needflow_graphviz needflow_graphviz internal 0.0043252 0.0021626 0.0006770 0.0036482 2 538.9 0.01
14 process_needflow_plantuml needflow_plantuml internal 0.0158763 0.0026461 0.0004180 0.0069557 6 1664.2 0.02
15 run needflow internal 0.0017454 0.0000499 0.0000340 0.0001682 35 495.6 0.00
16 run needimport internal 0.0018014 0.0018014 0.0018014 0.0018014 1 100.0 0.00
17 process_needpie needpie internal 0.2317547 0.1158774 0.0227873 0.2089674 2 917.0 0.33
18 process_needtables needtable internal 3.9143508 0.5591930 0.0161277 3.0773504 7 19081.1 5.53
19 process_needuml needuml internal 0.0664899 0.0221633 0.0010921 0.0418416 3 3831.1 0.09

Details

_build_needextract
(build_needextract, internal)

Amount 4.00000
Overall [s] 0.01046
Average [s] 0.00261
Min [s] 0.00187
Max [s] 0.00299
Min-Max spread [%] 159.98225
Ratio build time [%] 0.01
Max run analysis

Max: 0.0029925160015409347

args

['<sphinx.application.Sphinx object at 0x72af925d3e90>', '<Needextract docname="directives/needextract" filter="id == \'EXTRACT_FEATURE_1\'"', "{'docname': 'directives/needextract', 'lineno': 15, 'lineno_content': 18, 'docty", "{'ids': ['needextract-directives/needextract-0'], 'classes': [], 'names': [], 'd"]

kwargs

{}
Show Meta Data

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

Line: 166

Function docs

Creates a new need representation.

build_need_repr
(build_need_repr, internal)

Amount 222.00000
Overall [s] 0.76244
Average [s] 0.00343
Min [s] 0.00149
Max [s] 0.19176
Min-Max spread [%] 12869.62675
Ratio build time [%] 1.08
Max run analysis

Max: 0.19175975499820197

args

['<Need classes="[\'need\', \'need-user\', \'blue_border\']" ids="[\'USER_D\']" refid="USE', "{'docname': 'directives/needsequence', 'lineno': 58, 'lineno_content': 63, 'doct", '<sphinx.application.Sphinx object at 0x72af925d3e90>']

kwargs

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

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

Line: 39

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.00396
Average [s] 0.00099
Min [s] 0.00001
Max [s] 0.00346
Min-Max spread [%] 54143.32792
Ratio build time [%] 0.01
Max run analysis

Max: 0.003459758998360485

args

['<sphinx.application.Sphinx object at 0x72af925d3e90>', "{'docname': 'dynamic_functions', 'lineno': 41, 'lineno_content': 45, 'doctype': ", "{'xyz_123': {'docname': 'configuration', 'lineno': 248, 'lineno_content': 254, '", 'hours', 'hours.isdigit() and float(hours) > 10']

kwargs

{}
Show Meta Data

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

Line: 300

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.isdigit() and float(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.isdigit() and float(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.00031
Average [s] 0.00005
Min [s] 0.00000
Max [s] 0.00030
Min-Max spread [%] 22411.40491
Ratio build time [%] 0.00
Max run analysis

Max: 0.0002980719982588198

args

['<sphinx.application.Sphinx object at 0x72af925d3e90>', "{'docname': 'dynamic_functions', 'lineno': 57, 'lineno_content': 62, 'doctype': ", "{'xyz_123': {'docname': 'configuration', 'lineno': 248, 'lineno_content': 254, '", 'progress', 'status', 'in progress', 'type == "req" ']

kwargs

{}
Show Meta Data

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

Line: 171

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 21.00000
Overall [s] 0.00112
Average [s] 0.00005
Min [s] 0.00000
Max [s] 0.00110
Min-Max spread [%] 304707.36489
Ratio build time [%] 0.00
Max run analysis

Max: 0.0010969459981424734

args

['<sphinx.application.Sphinx object at 0x72af925d3e90>', "{'docname': 'dynamic_functions', 'lineno': 44, 'lineno_content': 47, 'doctype': ", '<sphinx_needs.views.NeedsView object at 0x72af84a7c280>', 'title']

kwargs

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

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

Line: 73

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

Max: 1.0699986887630075e-06

args

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

kwargs

{}
Show Meta Data

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

Line: 51

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 35.00000
Overall [s] 0.03464
Average [s] 0.00099
Min [s] 0.00002
Max [s] 0.00861
Min-Max spread [%] 49101.91945
Ratio build time [%] 0.05
Max run analysis

Max: 0.008607567000581184

args

["dict_values([{'docname': 'configuration', 'lineno': 248, 'lineno_content': 254, ", "NeedsSphinxConfig(from_toml='ubproject.toml', from_toml_table=[], types=[{'direc", 'id == "extend_test_002"', 'None']

kwargs

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

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

Line: 490

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 4608.00000
Overall [s] 0.02172
Average [s] 0.00000
Min [s] 0.00000
Max [s] 0.00016
Min-Max spread [%] 8613.56966
Ratio build time [%] 0.03
Max run analysis

Max: 0.0001593509987287689

args

["{'docname': 'configuration', 'lineno': 248, 'lineno_content': 254, 'doctype': '.", "NeedsSphinxConfig(from_toml='ubproject.toml', from_toml_table=[], types=[{'direc", 'search("([a-zA-Z0-9_.+-]+@[a-zA-Z0-9-]+\\.[a-zA-Z0-9-.]+$)", title)', '<sphinx_needs.views.NeedsAndPartsListView object at 0x72af7b27f2c0>', 'None']

kwargs

{'filter_compiled': '<code object <module> at 0x72af8d6b0ab0, file "<string>", line 1>', 'origin_docname': 'filter'}
Show Meta Data

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

Line: 553

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.00018
Average [s] 0.00009
Min [s] 0.00001
Max [s] 0.00018
Min-Max spread [%] 2750.78991
Ratio build time [%] 0.00
Max run analysis

Max: 0.00017770100021152757

args

['<sphinx.application.Sphinx object at 0x72af925d3e90>', "{'docname': 'dynamic_functions', 'lineno': 19, 'lineno_content': 23, 'doctype': ", "{'xyz_123': {'docname': 'configuration', 'lineno': 248, 'lineno_content': 254, '"]

kwargs

{}
Show Meta Data

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

Line: 404

Function docs


Extracts links from content of a need.

All need-links set by using ``:need:`NEED_ID``` get extracted.

Same links are only added once.

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.06005
Average [s] 0.06005
Min [s] 0.06005
Max [s] 0.06005
Min-Max spread [%] 100.00000
Ratio build time [%] 0.08
Max run analysis

Max: 0.060052261000237195

args

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

kwargs

{}
Show Meta Data

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

Line: 291

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.00433
Average [s] 0.00216
Min [s] 0.00068
Max [s] 0.00365
Min-Max spread [%] 538.87922
Ratio build time [%] 0.01
Max run analysis

Max: 0.0036481799979810603

args

['<sphinx.application.Sphinx object at 0x72af925d3e90>', '<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/5.1.0/lib/python3.11/site-packages/sphinx_needs/directives/needflow/_graphviz.py

Line: 45

Function docs

None

process_needflow_plantuml
(needflow_plantuml, internal)

Amount 6.00000
Overall [s] 0.01588
Average [s] 0.00265
Min [s] 0.00042
Max [s] 0.00696
Min-Max spread [%] 1664.23608
Ratio build time [%] 0.02
Max run analysis

Max: 0.0069557079987134784

args

['<sphinx.application.Sphinx object at 0x72af925d3e90>', '<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/5.1.0/lib/python3.11/site-packages/sphinx_needs/directives/needflow/_plantuml.py

Line: 184

Function docs

None

process_needpie
(needpie, internal)

Amount 2.00000
Overall [s] 0.23175
Average [s] 0.11588
Min [s] 0.02279
Max [s] 0.20897
Min-Max spread [%] 917.03381
Ratio build time [%] 0.33
Max run analysis

Max: 0.20896739099771366

args

['<sphinx.application.Sphinx object at 0x72af925d3e90>', '<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/5.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] 3.91435
Average [s] 0.55919
Min [s] 0.01613
Max [s] 3.07735
Min-Max spread [%] 19081.14873
Ratio build time [%] 5.53
Max run analysis

Max: 3.0773504240023613

args

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

Line: 122

Function docs


Replace all needtables nodes with a table of filtered nodes.

process_needuml
(needuml, internal)

Amount 3.00000
Overall [s] 0.06649
Average [s] 0.02216
Min [s] 0.00109
Max [s] 0.04184
Min-Max spread [%] 3831.13429
Ratio build time [%] 0.09
Max run analysis

Max: 0.04184157999770832

args

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

kwargs

{}
Show Meta Data

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

Line: 504

Function docs

None

run
(need, internal)

Amount 212.00000
Overall [s] 0.08861
Average [s] 0.00042
Min [s] 0.00000
Max [s] 0.00389
Min-Max spread [%] 480762.38794
Ratio build time [%] 0.13
Max run analysis

Max: 0.003894191002473235

args

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

kwargs

{}
Show Meta Data

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

Line: 57

Function docs

None

run
(needflow, internal)

Amount 35.00000
Overall [s] 0.00175
Average [s] 0.00005
Min [s] 0.00003
Max [s] 0.00017
Min-Max spread [%] 495.55523
Ratio build time [%] 0.00
Max run analysis

Max: 0.00016824100021040067

args

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

kwargs

{}
Show Meta Data

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

Line: 68

Function docs

None

run
(needimport, internal)

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

Max: 0.001801440001145238

args

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

kwargs

{}
Show Meta Data

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

Line: 53

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: 5.570000212173909e-06

args

['<sphinx.application.Sphinx object at 0x72af925d3e90>', "{'docname': 'dynamic_functions', 'lineno': 11, 'lineno_content': 13, 'doctype': ", '<sphinx_needs.views.NeedsView object at 0x72af84a7c280>', 'arg_1', '[1, 2, 3]']

kwargs

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

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

Line: 27

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