Sphinx-Needs Timing Measurement: Sphinx-Needs

Build Duration: 80.61s       Build timestamp: 2025-12-22T17:58:46.973170       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.7703991 0.0034860 0.0014499 0.2043019 221 14090.7 0.96
2 _build_needextract build_needextract internal 0.0114176 0.0028544 0.0018931 0.0037261 4 196.8 0.01
3 calc_sum dyn_func user 0.0067560 0.0016890 0.0000064 0.0063763 4 100098.4 0.01
4 check_linked_values dyn_func user 0.0003773 0.0000629 0.0000018 0.0003619 6 20560.4 0.00
5 copy dyn_func user 0.0054033 0.0002844 0.0000006 0.0053734 19 866676.4 0.01
6 echo dyn_func user 0.0000013 0.0000006 0.0000006 0.0000007 2 113.6 0.00
7 links_from_content dyn_func user 0.0001604 0.0000802 0.0000067 0.0001536 2 2289.7 0.00
8 test dyn_func user 0.0000183 0.0000183 0.0000183 0.0000183 1 100.0 0.00
9 filter_needs filtering internal 0.0344484 0.0049212 0.0000984 0.0124582 7 12659.4 0.04
10 filter_needs_and_parts filtering internal 0.1141495 0.0031708 0.0000126 0.0085239 36 67435.9 0.14
11 filter_single_need filtering internal 0.1064909 0.0000221 0.0000165 0.0001780 4811 1081.3 0.13
12 post_process_needs_data need_post_process internal 0.0740958 0.0740958 0.0740958 0.0740958 1 100.0 0.09
13 run need internal 0.2357627 0.0011121 0.0000027 0.0720831 212 2689668.9 0.29
14 process_needflow_graphviz needflow_graphviz internal 0.0065868 0.0032934 0.0008259 0.0057608 2 697.5 0.01
15 process_needflow_plantuml needflow_plantuml internal 0.0305056 0.0050843 0.0004506 0.0109496 6 2430.2 0.04
16 run needflow internal 0.0017802 0.0000509 0.0000340 0.0001382 35 407.0 0.00
17 run needimport internal 0.0026259 0.0026259 0.0026259 0.0026259 1 100.0 0.00
18 process_needpie needpie internal 0.2624655 0.1312328 0.0227412 0.2397243 2 1054.1 0.33
19 process_needtables needtable internal 3.6898129 0.5271161 0.0163457 3.0460712 7 18635.3 4.58
20 process_needuml needuml internal 0.0664996 0.0221665 0.0011851 0.0421266 3 3554.6 0.08

Details

_build_needextract
(build_needextract, internal)

Amount 4.00000
Overall [s] 0.01142
Average [s] 0.00285
Min [s] 0.00189
Max [s] 0.00373
Min-Max spread [%] 196.82592
Ratio build time [%] 0.01
Max run analysis

Max: 0.003726144999745884

args

['<sphinx.application.Sphinx object at 0x704f442b03d0>', '<Needextract docname="directives/needextract" filter="id == "EXTRACT_FEATURE_1""', "NeedItem(core={'id': 'EXTRACT_FEATURE_1', 'type': 'feature', 'type_name': 'Featu", "{'ids': ['needextract-directives/needextract-1'], 'classes': [], 'names': [], 'd"]

kwargs

{}
Show Meta Data

File: /home/docs/checkouts/readthedocs.org/user_builds/sphinx-needs/envs/6.3.0/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.77040
Average [s] 0.00349
Min [s] 0.00145
Max [s] 0.20430
Min-Max spread [%] 14090.73062
Ratio build time [%] 0.96
Max run analysis

Max: 0.204301925999971

args

['<Need classes="need need-req" ids="R_F199E" refid="R_F199E"><paragraph>With text', "NeedItem(core={'id': 'R_F199E', 'type': 'req', 'type_name': 'Requirement', 'type", '<sphinx.application.Sphinx object at 0x704f442b03d0>']

kwargs

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

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

Max: 0.006376270001055673

args

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

kwargs

{}
Show Meta Data

File: /home/docs/checkouts/readthedocs.org/user_builds/sphinx-needs/envs/6.3.0/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.00038
Average [s] 0.00006
Min [s] 0.00000
Max [s] 0.00036
Min-Max spread [%] 20560.40266
Ratio build time [%] 0.00
Max run analysis

Max: 0.0003618629998527467

args

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

kwargs

{}
Show Meta Data

File: /home/docs/checkouts/readthedocs.org/user_builds/sphinx-needs/envs/6.3.0/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.00540
Average [s] 0.00028
Min [s] 0.00000
Max [s] 0.00537
Min-Max spread [%] 866676.41419
Ratio build time [%] 0.01
Max run analysis

Max: 0.005373400001190021

args

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

kwargs

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

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

Max: 6.700010999338701e-07

args

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

kwargs

{}
Show Meta Data

File: /home/docs/checkouts/readthedocs.org/user_builds/sphinx-needs/envs/6.3.0/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.03445
Average [s] 0.00492
Min [s] 0.00010
Max [s] 0.01246
Min-Max spread [%] 12659.39488
Ratio build time [%] 0.04
Max run analysis

Max: 0.012458237000828376

args

["dict_values([NeedItem(core={'id': 'xyz_123', 'type': 'req', 'type_name': 'Requir", "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/6.3.0/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.11415
Average [s] 0.00317
Min [s] 0.00001
Max [s] 0.00852
Min-Max spread [%] 67435.92245
Ratio build time [%] 0.14
Max run analysis

Max: 0.00852390000000014

args

["dict_values([NeedItem(core={'id': 'xyz_123', 'type': 'req', 'type_name': 'Requir", "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/6.3.0/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.10649
Average [s] 0.00002
Min [s] 0.00002
Max [s] 0.00018
Min-Max spread [%] 1081.30020
Ratio build time [%] 0.13
Max run analysis

Max: 0.00017798199951357674

args

["NeedItem(core={'id': 'xyz_123', 'type': 'req', 'type_name': 'Requirement', 'type", "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 0x704f2ed19400>', 'None']

kwargs

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

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

Max: 0.00015364099999715108

args

['<sphinx.application.Sphinx object at 0x704f442b03d0>', "NeedItem(core={'id': 'CON_SPEC_1', 'type': 'spec', 'type_name': 'Specification',", "{'xyz_123': NeedItem(core={'id': 'xyz_123', 'type': 'req', 'type_name': 'Require"]

kwargs

{}
Show Meta Data

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

Max: 0.0740958110000065

args

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

kwargs

{}
Show Meta Data

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

Line: 341

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.00659
Average [s] 0.00329
Min [s] 0.00083
Max [s] 0.00576
Min-Max spread [%] 697.50871
Ratio build time [%] 0.01
Max run analysis

Max: 0.00576084299973445

args

['<sphinx.application.Sphinx object at 0x704f442b03d0>', '<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/6.3.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.03051
Average [s] 0.00508
Min [s] 0.00045
Max [s] 0.01095
Min-Max spread [%] 2430.19460
Ratio build time [%] 0.04
Max run analysis

Max: 0.010949581999739166

args

['<sphinx.application.Sphinx object at 0x704f442b03d0>', '<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/6.3.0/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.26247
Average [s] 0.13123
Min [s] 0.02274
Max [s] 0.23972
Min-Max spread [%] 1054.14048
Ratio build time [%] 0.33
Max run analysis

Max: 0.2397243220002565

args

['<sphinx.application.Sphinx object at 0x704f442b03d0>', '<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/6.3.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.68981
Average [s] 0.52712
Min [s] 0.01635
Max [s] 3.04607
Min-Max spread [%] 18635.34951
Ratio build time [%] 4.58
Max run analysis

Max: 3.0460712439999043

args

['<sphinx.application.Sphinx object at 0x704f442b03d0>', '<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/6.3.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.06650
Average [s] 0.02217
Min [s] 0.00119
Max [s] 0.04213
Min-Max spread [%] 3554.56296
Ratio build time [%] 0.08
Max run analysis

Max: 0.04212658300093608

args

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

Line: 507

Function docs

None

run
(need, internal)

Amount 212.00000
Overall [s] 0.23576
Average [s] 0.00111
Min [s] 0.00000
Max [s] 0.07208
Min-Max spread [%] 2689668.85957
Ratio build time [%] 0.29
Max run analysis

Max: 0.07208309700035898

args

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

kwargs

{}
Show Meta Data

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

Line: 64

Function docs

None

run
(needflow, internal)

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

Max: 0.000138240999149275

args

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

kwargs

{}
Show Meta Data

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

Max: 0.002625905000968487

args

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

kwargs

{}
Show Meta Data

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

Max: 1.832999987527728e-05

args

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

kwargs

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

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