Sphinx-Needs Timing Measurement: Sphinx-Needs

Build Duration: 74.21s       Build timestamp: 2025-12-23T12:52:12.403827       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.7706469 0.0034871 0.0014666 0.2117198 221 14435.9 1.04
2 _build_needextract build_needextract internal 0.0103243 0.0025811 0.0018539 0.0029185 4 157.4 0.01
3 calc_sum dyn_func user 0.0067343 0.0016836 0.0000062 0.0063834 4 103124.1 0.01
4 check_linked_values dyn_func user 0.0003677 0.0000613 0.0000018 0.0003527 6 19274.5 0.00
5 copy dyn_func user 0.0053149 0.0002797 0.0000006 0.0052867 19 927486.6 0.01
6 echo dyn_func user 0.0000013 0.0000006 0.0000005 0.0000008 2 150.0 0.00
7 links_from_content dyn_func user 0.0001573 0.0000786 0.0000062 0.0001511 2 2448.6 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.0340759 0.0048680 0.0000905 0.0123163 7 13606.0 0.05
10 filter_needs_and_parts filtering internal 0.1136306 0.0031564 0.0000139 0.0084309 36 60562.3 0.15
11 filter_single_need filtering internal 0.1064482 0.0000221 0.0000163 0.0001856 4811 1142.4 0.14
12 post_process_needs_data need_post_process internal 0.0702034 0.0702034 0.0702034 0.0702034 1 100.0 0.09
13 run need internal 0.1671678 0.0007885 0.0000032 0.0057710 212 183206.0 0.23
14 process_needflow_graphviz needflow_graphviz internal 0.0067020 0.0033510 0.0008849 0.0058171 2 657.4 0.01
15 process_needflow_plantuml needflow_plantuml internal 0.0307352 0.0051225 0.0012388 0.0110038 6 888.3 0.04
16 run needflow internal 0.0017558 0.0000502 0.0000347 0.0001415 35 408.3 0.00
17 run needimport internal 0.0026734 0.0026734 0.0026734 0.0026734 1 100.0 0.00
18 process_needpie needpie internal 0.2584836 0.1292418 0.0216396 0.2368440 2 1094.5 0.35
19 process_needtables needtable internal 3.6815455 0.5259351 0.0160827 3.0406706 7 18906.5 4.96
20 process_needuml needuml internal 0.0666029 0.0222010 0.0011044 0.0419405 3 3797.4 0.09

Details

_build_needextract
(build_needextract, internal)

Amount 4.00000
Overall [s] 0.01032
Average [s] 0.00258
Min [s] 0.00185
Max [s] 0.00292
Min-Max spread [%] 157.42548
Ratio build time [%] 0.01
Max run analysis

Max: 0.0029185000003053574

args

['<sphinx.application.Sphinx object at 0x7706f3fa7e90>', '<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/1613/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 221.00000
Overall [s] 0.77065
Average [s] 0.00349
Min [s] 0.00147
Max [s] 0.21172
Min-Max spread [%] 14435.89927
Ratio build time [%] 1.04
Max run analysis

Max: 0.21171978600068542

args

['<Need classes="[\'need\', \'need-action\']" ids="[\'ACT_TICKET_WORK\']" refid="ACT_TIC', "NeedItem(core={'id': 'ACT_TICKET_WORK', 'type': 'action', 'type_name': 'Action',", '<sphinx.application.Sphinx object at 0x7706f3fa7e90>']

kwargs

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

File: /home/docs/checkouts/readthedocs.org/user_builds/sphinx-needs/envs/1613/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.00673
Average [s] 0.00168
Min [s] 0.00001
Max [s] 0.00638
Min-Max spread [%] 103124.10405
Ratio build time [%] 0.01
Max run analysis

Max: 0.006383383000866161

args

['<sphinx.application.Sphinx object at 0x7706f3fa7e90>', "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/1613/lib/python3.11/site-packages/sphinx_needs/functions/common.py

Line: 301

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.00035
Min-Max spread [%] 19274.48355
Ratio build time [%] 0.00
Max run analysis

Max: 0.0003527230001054704

args

['<sphinx.application.Sphinx object at 0x7706f3fa7e90>', "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/1613/lib/python3.11/site-packages/sphinx_needs/functions/common.py

Line: 172

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.00531
Average [s] 0.00028
Min [s] 0.00000
Max [s] 0.00529
Min-Max spread [%] 927486.64224
Ratio build time [%] 0.01
Max run analysis

Max: 0.005286677000185591

args

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

kwargs

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

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

Line: 74

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

Max: 7.500002539018169e-07

args

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

kwargs

{}
Show Meta Data

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

Line: 52

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.03408
Average [s] 0.00487
Min [s] 0.00009
Max [s] 0.01232
Min-Max spread [%] 13606.04060
Ratio build time [%] 0.05
Max run analysis

Max: 0.012316324000494205

args

["dict_values([NeedItem(core={'id': 'EXTRA_REQ_001', 'type': 'req', 'type_name': '", "NeedsSphinxConfig(from_toml='ubproject.toml', from_toml_table=[], schema_validat", '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/1613/lib/python3.11/site-packages/sphinx_needs/filter_common.py

Line: 492

Function docs

None

filter_needs_and_parts
(filtering, internal)

Amount 36.00000
Overall [s] 0.11363
Average [s] 0.00316
Min [s] 0.00001
Max [s] 0.00843
Min-Max spread [%] 60562.29907
Ratio build time [%] 0.15
Max run analysis

Max: 0.008430878000581288

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': 'id == "extend_test_002"', 'current_need': 'None', 'location': "('directives/needextend', 62)", 'append_warning': '', 'origin_docname': 'directives/needextend'}
Show Meta Data

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

Line: 514

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 4811.00000
Overall [s] 0.10645
Average [s] 0.00002
Min [s] 0.00002
Max [s] 0.00019
Min-Max spread [%] 1142.40615
Ratio build time [%] 0.14
Max run analysis

Max: 0.00018564099991635885

args

["NeedItem(core={'id': 'EXTRA_REQ_001', 'type': 'req', 'type_name': 'Requirement',", "NeedsSphinxConfig(from_toml='ubproject.toml', from_toml_table=[], schema_validat", 'search(r"([a-zA-Z0-9_.+-]+@[a-zA-Z0-9-]+\\.[a-zA-Z0-9-.]+$)", title)', '<sphinx_needs.views.NeedsAndPartsListView object at 0x7706f1b5fd80>', 'None']

kwargs

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

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

Line: 642

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.00016
Average [s] 0.00008
Min [s] 0.00001
Max [s] 0.00015
Min-Max spread [%] 2448.63884
Ratio build time [%] 0.00
Max run analysis

Max: 0.00015108099978533573

args

['<sphinx.application.Sphinx object at 0x7706f3fa7e90>', "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/1613/lib/python3.11/site-packages/sphinx_needs/functions/common.py

Line: 406

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.07020
Average [s] 0.07020
Min [s] 0.07020
Max [s] 0.07020
Min-Max spread [%] 100.00000
Ratio build time [%] 0.09
Max run analysis

Max: 0.07020340300005046

args

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

kwargs

{}
Show Meta Data

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

Line: 343

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.00670
Average [s] 0.00335
Min [s] 0.00088
Max [s] 0.00582
Min-Max spread [%] 657.36474
Ratio build time [%] 0.01
Max run analysis

Max: 0.005817060000481433

args

['<sphinx.application.Sphinx object at 0x7706f3fa7e90>', '<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/1613/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.03074
Average [s] 0.00512
Min [s] 0.00124
Max [s] 0.01100
Min-Max spread [%] 888.27515
Ratio build time [%] 0.04
Max run analysis

Max: 0.011003765999703319

args

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

Line: 183

Function docs

None

process_needpie
(needpie, internal)

Amount 2.00000
Overall [s] 0.25848
Average [s] 0.12924
Min [s] 0.02164
Max [s] 0.23684
Min-Max spread [%] 1094.49564
Ratio build time [%] 0.35
Max run analysis

Max: 0.23684400799902505

args

['<sphinx.application.Sphinx object at 0x7706f3fa7e90>', '<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/1613/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.68155
Average [s] 0.52594
Min [s] 0.01608
Max [s] 3.04067
Min-Max spread [%] 18906.48016
Ratio build time [%] 4.96
Max run analysis

Max: 3.040670594000403

args

['<sphinx.application.Sphinx object at 0x7706f3fa7e90>', '<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/1613/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.06660
Average [s] 0.02220
Min [s] 0.00110
Max [s] 0.04194
Min-Max spread [%] 3797.41445
Ratio build time [%] 0.09
Max run analysis

Max: 0.041940467999666

args

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

Line: 507

Function docs

None

run
(need, internal)

Amount 212.00000
Overall [s] 0.16717
Average [s] 0.00079
Min [s] 0.00000
Max [s] 0.00577
Min-Max spread [%] 183205.98032
Ratio build time [%] 0.23
Max run analysis

Max: 0.0057709890006663045

args

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

kwargs

{}
Show Meta Data

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

Line: 64

Function docs

None

run
(needflow, internal)

Amount 35.00000
Overall [s] 0.00176
Average [s] 0.00005
Min [s] 0.00003
Max [s] 0.00014
Min-Max spread [%] 408.28571
Ratio build time [%] 0.00
Max run analysis

Max: 0.00014147100046102423

args

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

kwargs

{}
Show Meta Data

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

Max: 0.002673447999768541

args

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

kwargs

{}
Show Meta Data

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

args

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

kwargs

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

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

Line: 28

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