Sphinx-Needs Timing Measurement: Sphinx-Needs

Build Duration: 69.72s       Build timestamp: 2026-03-19T13:27:47.348333       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.4470528 0.0020138 0.0000978 0.2208328 222 225867.4 0.64
2 _build_needextract build_needextract internal 0.0042642 0.0010660 0.0004228 0.0013858 4 327.7 0.01
3 calc_sum dyn_func user 0.0077458 0.0019364 0.0000074 0.0073622 4 100030.4 0.01
4 check_linked_values dyn_func user 0.0004107 0.0000685 0.0000023 0.0003940 6 17434.2 0.00
5 copy dyn_func user 0.0062400 0.0003284 0.0000006 0.0062125 19 1089907.6 0.01
6 echo dyn_func user 0.0000011 0.0000006 0.0000005 0.0000006 2 115.1 0.00
7 links_from_content dyn_func user 0.0001712 0.0000856 0.0000691 0.0001020 2 147.6 0.00
8 test dyn_func user 0.0000065 0.0000065 0.0000065 0.0000065 1 100.0 0.00
9 filter_needs filtering internal 0.0394732 0.0056390 0.0001070 0.0132473 7 12376.1 0.06
10 filter_needs_and_parts filtering internal 0.1305228 0.0036256 0.0000242 0.0092155 36 38080.6 0.19
11 filter_single_need filtering internal 0.1238093 0.0000256 0.0000195 0.0002035 4831 1045.5 0.18
12 post_process_needs_data need_post_process internal 0.0802763 0.0802763 0.0802763 0.0802763 1 100.0 0.12
13 run need internal 0.1266213 0.0005973 0.0000029 0.0052177 212 178079.7 0.18
14 process_needflow_graphviz needflow_graphviz internal 0.0071237 0.0035618 0.0009171 0.0062066 2 676.8 0.01
15 process_needflow_plantuml needflow_plantuml internal 0.0339307 0.0056551 0.0005057 0.0139662 6 2761.8 0.05
16 run needflow internal 0.0017599 0.0000503 0.0000338 0.0001386 35 409.8 0.00
17 run needimport internal 0.0025708 0.0025708 0.0025708 0.0025708 1 100.0 0.00
18 process_needpie needpie internal 0.2623794 0.1311897 0.0220771 0.2403023 2 1088.5 0.38
19 process_needtables needtable internal 0.3026074 0.0432296 0.0011631 0.2582092 7 22199.5 0.43
20 process_needuml needuml internal 0.0060580 0.0020193 0.0002193 0.0032901 3 1500.2 0.01

Details

_build_needextract
(build_needextract, internal)

Amount 4.00000
Overall [s] 0.00426
Average [s] 0.00107
Min [s] 0.00042
Max [s] 0.00139
Min-Max spread [%] 327.73150
Ratio build time [%] 0.01
Max run analysis

Max: 0.001385792998917168

args

['<sphinx.application.Sphinx object at 0x7e6b9b779090>', '<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/8.0.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 222.00000
Overall [s] 0.44705
Average [s] 0.00201
Min [s] 0.00010
Max [s] 0.22083
Min-Max spread [%] 225867.42060
Ratio build time [%] 0.64
Max run analysis

Max: 0.22083283299980394

args

['<Need classes="need need-spec" ids="OWN_ID_123" refid="OWN_ID_123"><paragraph cl', "NeedItem(core={'id': 'OWN_ID_123', 'type': 'spec', 'type_name': 'Specification',", '<sphinx.application.Sphinx object at 0x7e6b9b779090>']

kwargs

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

File: /home/docs/checkouts/readthedocs.org/user_builds/sphinx-needs/envs/8.0.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.00775
Average [s] 0.00194
Min [s] 0.00001
Max [s] 0.00736
Min-Max spread [%] 100030.40243
Ratio build time [%] 0.01
Max run analysis

Max: 0.007362238000496291

args

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

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

Max: 0.00039401399953931104

args

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

.. 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.00624
Average [s] 0.00033
Min [s] 0.00000
Max [s] 0.00621
Min-Max spread [%] 1089907.56797
Ratio build time [%] 0.01
Max run analysis

Max: 0.0062124570013111224

args

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

kwargs

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

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

Line: 77

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

Max: 0.0000006099999154685065

args

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

kwargs

{}
Show Meta Data

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

.. need-example::

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

filter_needs
(filtering, internal)

Amount 7.00000
Overall [s] 0.03947
Average [s] 0.00564
Min [s] 0.00011
Max [s] 0.01325
Min-Max spread [%] 12376.06789
Ratio build time [%] 0.06
Max run analysis

Max: 0.013247343000330147

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/8.0.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.13052
Average [s] 0.00363
Min [s] 0.00002
Max [s] 0.00922
Min-Max spread [%] 38080.64662
Ratio build time [%] 0.19
Max run analysis

Max: 0.009215516000040225

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/8.0.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 4831.00000
Overall [s] 0.12381
Average [s] 0.00003
Min [s] 0.00002
Max [s] 0.00020
Min-Max spread [%] 1045.53959
Ratio build time [%] 0.18
Max run analysis

Max: 0.0002034620010817889

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 0x7e6b83835c00>', 'None']

kwargs

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

File: /home/docs/checkouts/readthedocs.org/user_builds/sphinx-needs/envs/8.0.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.00017
Average [s] 0.00009
Min [s] 0.00007
Max [s] 0.00010
Min-Max spread [%] 147.56946
Ratio build time [%] 0.00
Max run analysis

Max: 0.00010203099918726366

args

['<sphinx.application.Sphinx object at 0x7e6b9b779090>', "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/8.0.0/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.08028
Average [s] 0.08028
Min [s] 0.08028
Max [s] 0.08028
Min-Max spread [%] 100.00000
Ratio build time [%] 0.12
Max run analysis

Max: 0.08027631400000246

args

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

kwargs

{}
Show Meta Data

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

Line: 344

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.00712
Average [s] 0.00356
Min [s] 0.00092
Max [s] 0.00621
Min-Max spread [%] 676.78528
Ratio build time [%] 0.01
Max run analysis

Max: 0.006206588001077762

args

['<sphinx.application.Sphinx object at 0x7e6b9b779090>', '<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/8.0.0/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.03393
Average [s] 0.00566
Min [s] 0.00051
Max [s] 0.01397
Min-Max spread [%] 2761.78725
Ratio build time [%] 0.05
Max run analysis

Max: 0.013966219999929308

args

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

Line: 186

Function docs

none

process_needpie
(needpie, internal)

Amount 2.00000
Overall [s] 0.26238
Average [s] 0.13119
Min [s] 0.02208
Max [s] 0.24030
Min-Max spread [%] 1088.46796
Ratio build time [%] 0.38
Max run analysis

Max: 0.24030230199969083

args

['<sphinx.application.Sphinx object at 0x7e6b9b779090>', '<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/8.0.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] 0.30261
Average [s] 0.04323
Min [s] 0.00116
Max [s] 0.25821
Min-Max spread [%] 22199.49789
Ratio build time [%] 0.43
Max run analysis

Max: 0.25820924199979345

args

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

Line: 123

Function docs


Replace all needtables nodes with a table of filtered nodes.

process_needuml
(needuml, internal)

Amount 3.00000
Overall [s] 0.00606
Average [s] 0.00202
Min [s] 0.00022
Max [s] 0.00329
Min-Max spread [%] 1500.17327
Ratio build time [%] 0.01
Max run analysis

Max: 0.003290059999926598

args

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

Line: 562

Function docs

none

run
(need, internal)

Amount 212.00000
Overall [s] 0.12662
Average [s] 0.00060
Min [s] 0.00000
Max [s] 0.00522
Min-Max spread [%] 178079.74379
Ratio build time [%] 0.18
Max run analysis

Max: 0.005217738000283134

args

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

kwargs

{}
Show Meta Data

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

Line: 65

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

Max: 0.00013864100037608296

args

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

kwargs

{}
Show Meta Data

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

Line: 69

Function docs

none

run
(needimport, internal)

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

Max: 0.002570814000137034

args

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

kwargs

{}
Show Meta Data

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

args

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

kwargs

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

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

.. need-example::

.. req:: test requirement

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

:return: single test string