Sphinx-Needs Timing Measurement: Sphinx-Needs

Build Duration: 119.27s       Build timestamp: 2026-09-03T11:44:49.521214       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.3087481 0.0013783 0.0000769 0.0041817 224 5434.8 0.26
2 _build_needextract build_needextract internal 0.0056238 0.0014059 0.0004770 0.0018903 4 396.3 0.00
3 calc_sum dyn_func user 0.0067249 0.0016812 0.0000088 0.0062382 4 71131.3 0.01
4 check_linked_values dyn_func user 0.0000960 0.0000160 0.0000032 0.0000717 6 2274.6 0.00
5 copy dyn_func user 0.0039737 0.0002091 0.0000010 0.0039339 19 401422.2 0.00
6 echo dyn_func user 0.0000021 0.0000011 0.0000010 0.0000011 2 105.8 0.00
7 links_from_content dyn_func user 0.0002229 0.0001114 0.0000856 0.0001373 2 160.4 0.00
8 test dyn_func user 0.0000062 0.0000062 0.0000062 0.0000062 1 100.0 0.00
9 filter_needs filtering internal 0.0259003 0.0037000 0.0000786 0.0164568 7 20926.2 0.02
10 filter_needs_and_parts filtering internal 0.0514425 0.0013903 0.0000709 0.0124125 37 17499.5 0.04
11 filter_single_need filtering internal 0.0310771 0.0000157 0.0000022 0.0001065 1978 4773.7 0.03
12 post_process_needs_data need_post_process internal 0.0966940 0.0966940 0.0966940 0.0966940 1 100.0 0.08
13 run need internal 0.1207199 0.0006421 0.0000030 0.0028119 188 94676.7 0.10
14 process_needflow_graphviz needflow_graphviz internal 0.0118014 0.0059007 0.0010848 0.0107167 2 987.9 0.01
15 process_needflow_plantuml needflow_plantuml internal 0.0313018 0.0052170 0.0007004 0.0197268 6 2816.4 0.03
16 run needflow internal 0.0027883 0.0000680 0.0000496 0.0001951 41 393.3 0.00
17 run needimport internal 0.0030316 0.0030316 0.0030316 0.0030316 1 100.0 0.00
18 process_needpie needpie internal 0.4271866 0.2135933 0.0322480 0.3949386 2 1224.7 0.36
19 process_needtables needtable internal 0.1411415 0.0201631 0.0021703 0.1012335 7 4664.5 0.12
20 process_needuml needuml internal 0.0087867 0.0029289 0.0002928 0.0049486 3 1689.8 0.01

Details

_build_needextract
(build_needextract, internal)

Amount 4.00000
Overall [s] 0.00562
Average [s] 0.00141
Min [s] 0.00048
Max [s] 0.00189
Min-Max spread [%] 396.25129
Ratio build time [%] 0.00
Max run analysis

Max: 0.0018902930005424423

args

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

Function docs

Creates a new need representation.

build_need_repr
(build_need_repr, internal)

Amount 224.00000
Overall [s] 0.30875
Average [s] 0.00138
Min [s] 0.00008
Max [s] 0.00418
Min-Max spread [%] 5434.83885
Ratio build time [%] 0.26
Max run analysis

Max: 0.004181727999821305

args

['<Need classes="need need-issue" ids="EXAMPLE_166" refid="EXAMPLE_166"><literal_b', "NeedItem(core={'id': 'EXAMPLE_166', 'type': 'issue', 'type_name': 'Issue', 'type", '<sphinx.application.Sphinx object at 0x7ea6bce01610>']

kwargs

{'docname': 'directives/needservice'}
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: 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.00672
Average [s] 0.00168
Min [s] 0.00001
Max [s] 0.00624
Min-Max spread [%] 71131.30709
Ratio build time [%] 0.01
Max run analysis

Max: 0.006238215000848868

args

['<sphinx.application.Sphinx object at 0x7ea6bce01610>', "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/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**

.. 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.00010
Average [s] 0.00002
Min [s] 0.00000
Max [s] 0.00007
Min-Max spread [%] 2274.57895
Ratio build time [%] 0.00
Max run analysis

Max: 0.00007167200055846479

args

['<sphinx.application.Sphinx object at 0x7ea6bce01610>', "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/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**

.. 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.00397
Average [s] 0.00021
Min [s] 0.00000
Max [s] 0.00393
Min-Max spread [%] 401422.22358
Ratio build time [%] 0.00
Max run analysis

Max: 0.003933939999114955

args

['<sphinx.application.Sphinx object at 0x7ea6bce01610>', "NeedItem(core={'id': 'copy_4', 'type': 'test', 'type_name': 'Test Case', 'type_p", '<sphinx_needs.views.NeedsView object at 0x7ea6a4fa6700>', '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

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

Max: 0.0000011000010999850929

args

['<sphinx.application.Sphinx object at 0x7ea6bce01610>', 'None', '<sphinx_needs.views.NeedsView object at 0x7ea6a4fa6700>', '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.

.. syntax-example::

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

filter_needs
(filtering, internal)

Amount 7.00000
Overall [s] 0.02590
Average [s] 0.00370
Min [s] 0.00008
Max [s] 0.01646
Min-Max spread [%] 20926.18737
Ratio build time [%] 0.02
Max run analysis

Max: 0.016456772000310593

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/stable/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.05144
Average [s] 0.00139
Min [s] 0.00007
Max [s] 0.01241
Min-Max spread [%] 17499.46974
Ratio build time [%] 0.04
Max run analysis

Max: 0.0124125490001461

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

Max: 0.00010645300062606111

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/stable/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.00022
Average [s] 0.00011
Min [s] 0.00009
Max [s] 0.00014
Min-Max spread [%] 160.37475
Ratio build time [%] 0.00
Max run analysis

Max: 0.00013728399972023908

args

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

Max: 0.09669398500045645

args

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

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: 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.01180
Average [s] 0.00590
Min [s] 0.00108
Max [s] 0.01072
Min-Max spread [%] 987.90098
Ratio build time [%] 0.01
Max run analysis

Max: 0.010716650998801924

args

['<sphinx.application.Sphinx object at 0x7ea6bce01610>', '<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.03130
Average [s] 0.00522
Min [s] 0.00070
Max [s] 0.01973
Min-Max spread [%] 2816.37894
Ratio build time [%] 0.03
Max run analysis

Max: 0.0197267629991984

args

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

Function docs

None

process_needpie
(needpie, internal)

Amount 2.00000
Overall [s] 0.42719
Average [s] 0.21359
Min [s] 0.03225
Max [s] 0.39494
Min-Max spread [%] 1224.69110
Ratio build time [%] 0.36
Max run analysis

Max: 0.3949385710002389

args

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

Function docs

None

process_needtables
(needtable, internal)

Amount 7.00000
Overall [s] 0.14114
Average [s] 0.02016
Min [s] 0.00217
Max [s] 0.10123
Min-Max spread [%] 4664.48944
Ratio build time [%] 0.12
Max run analysis

Max: 0.10123346099862829

args

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

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.00029
Max [s] 0.00495
Min-Max spread [%] 1689.80803
Ratio build time [%] 0.01
Max run analysis

Max: 0.004948568999679992

args

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

Function docs

None

run
(need, internal)

Amount 188.00000
Overall [s] 0.12072
Average [s] 0.00064
Min [s] 0.00000
Max [s] 0.00281
Min-Max spread [%] 94676.72049
Ratio build time [%] 0.10
Max run analysis

Max: 0.002811898999425466

args

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

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 41.00000
Overall [s] 0.00279
Average [s] 0.00007
Min [s] 0.00005
Max [s] 0.00020
Min-Max spread [%] 393.34234
Ratio build time [%] 0.00
Max run analysis

Max: 0.00019514499945216812

args

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

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: 89

Function docs

None

run
(needimport, internal)

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

Max: 0.003031645001101424

args

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

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

args

['<sphinx.application.Sphinx object at 0x7ea6bce01610>', "NeedItem(core={'id': 'R_A6A4E', 'type': 'req', 'type_name': 'Requirement', 'type", '<sphinx_needs.views.NeedsView object at 0x7ea6a4fa6700>', '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.

.. syntax-example::

.. req:: test requirement

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

:return: single test string