Sphinx-Needs Timing Measurement: Sphinx-Needs

Build Duration: 120.54s       Build timestamp: 2025-03-24T09:28:51.037216       Elements: 19

Overview

# Function Category Source Overall [s] Average [s] Min [s] Max [s] Amount Min/Max spread [%] Ratio build time[%]
1 build_need_repr build_need_repr internal 1.4428926 0.0060882 0.0018311 0.3390315 237 18514.7 1.20
2 _build_needextract build_needextract internal 0.0158872 0.0039718 0.0035455 0.0043717 4 123.3 0.01
3 calc_sum dyn_func user 0.0054031 0.0013508 0.0000136 0.0049461 4 36440.8 0.00
4 check_linked_values dyn_func user 0.0004545 0.0000757 0.0000020 0.0004331 6 21281.7 0.00
5 copy dyn_func user 0.0013880 0.0000661 0.0000006 0.0013518 21 226813.6 0.00
6 echo dyn_func user 0.0000024 0.0000012 0.0000009 0.0000016 2 178.0 0.00
7 links_from_content dyn_func user 0.0002380 0.0001190 0.0000177 0.0002203 2 1246.1 0.00
8 test dyn_func user 0.0000074 0.0000074 0.0000074 0.0000074 1 100.0 0.00
9 filter_needs filtering internal 0.0433437 0.0012384 0.0000216 0.0129035 35 59835.2 0.04
10 filter_single_need filtering internal 0.0296348 0.0000060 0.0000022 0.0002066 4907 9210.8 0.02
11 post_process_needs_data need_post_process internal 0.0843343 0.0843343 0.0843343 0.0843343 1 100.0 0.07
12 run need internal 0.1138375 0.0005370 0.0000013 0.0048132 212 383219.0 0.09
13 process_needflow_graphviz needflow_graphviz internal 0.0056516 0.0028258 0.0008684 0.0047832 2 550.8 0.00
14 process_needflow_plantuml needflow_plantuml internal 0.0205851 0.0034308 0.0006046 0.0087364 6 1445.1 0.02
15 run needflow internal 0.0024697 0.0000706 0.0000393 0.0001921 35 489.1 0.00
16 run needimport internal 0.0023564 0.0023564 0.0023564 0.0023564 1 100.0 0.00
17 process_needpie needpie internal 0.3209798 0.1604899 0.0311702 0.2898096 2 929.8 0.27
18 process_needtables needtable internal 4.6358877 0.6622697 0.0201605 3.8302793 7 18998.9 3.85
19 process_needuml needuml internal 0.0932131 0.0310710 0.0025958 0.0577963 3 2226.5 0.08

Details

_build_needextract
(build_needextract, internal)

Amount 4.00000
Overall [s] 0.01589
Average [s] 0.00397
Min [s] 0.00355
Max [s] 0.00437
Min-Max spread [%] 123.30108
Ratio build time [%] 0.01
Max run analysis

Max: 0.0043716989999893485

args

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

kwargs

{}
Show Meta Data

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

Line: 166

Function docs

Creates a new need representation.

build_need_repr
(build_need_repr, internal)

Amount 237.00000
Overall [s] 1.44289
Average [s] 0.00609
Min [s] 0.00183
Max [s] 0.33903
Min-Max spread [%] 18514.74997
Ratio build time [%] 1.20
Max run analysis

Max: 0.3390315479999799

args

['<Need classes="need need-req" ids="EX_CLEAN_LP" refid="EX_CLEAN_LP"><paragraph>T', "{'docname': 'layout_styles', 'lineno': 138, 'lineno_content': 145, 'doctype': '.", '<sphinx.application.Sphinx object at 0x731017bfbe10>']

kwargs

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

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

Line: 39

Function docs

Create an output representation for a need.

:param layout: Override layout from need data / config
:param style: Override style from need data / config
:param docname: Override docname from need data / config

The created table will have the following docutils structure::

- table
-- tgroup
--- colspec (partial used)
--- thead (not used)
--- tbody
---- row
----- entry
------ custom layout nodes

The level structure must be kept, otherwise docutils can not handle it!

calc_sum
(dyn_func, user)

Amount 4.00000
Overall [s] 0.00540
Average [s] 0.00135
Min [s] 0.00001
Max [s] 0.00495
Min-Max spread [%] 36440.75757
Ratio build time [%] 0.00
Max run analysis

Max: 0.0049461039999414425

args

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

kwargs

{}
Show Meta Data

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

Line: 300

Function docs


Sums the values of a given option in filtered needs up to single number.

Useful e.g. for calculating the amount of needed hours for implementation of all linked
specification needs.


**Input data**

.. spec:: Do this
:id: sum_input_1
:hours: 7
:collapse: False

.. spec:: Do that
:id: sum_input_2
:hours: 15
:collapse: False

.. spec:: Do too much
:id: sum_input_3
:hours: 110
:collapse: False

**Example 2**

.. need-example::

.. req:: Result 1
:amount: [[calc_sum("hours")]]
:collapse: False


**Example 2**

.. need-example::

.. req:: Result 2
:amount: [[calc_sum("hours", "hours.isdigit() and float(hours) > 10")]]
:collapse: False

**Example 3**

.. need-example::

.. req:: Result 3
:links: sum_input_1; sum_input_3
:amount: [[calc_sum("hours", links_only="True")]]
:collapse: False

**Example 4**

.. need-example::

.. req:: Result 4
:links: sum_input_1; sum_input_3
:amount: [[calc_sum("hours", "hours.isdigit() and float(hours) > 10", "True")]]
:collapse: False

:param option: Options, from which the numbers shall be taken
:param filter: Filter string, which all needs must passed to get their value added.
:param links_only: If "True", only linked needs are taken into account.

:return: A float number

check_linked_values
(dyn_func, user)

Amount 6.00000
Overall [s] 0.00045
Average [s] 0.00008
Min [s] 0.00000
Max [s] 0.00043
Min-Max spread [%] 21281.72026
Ratio build time [%] 0.00
Max run analysis

Max: 0.0004330830000753849

args

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

kwargs

{}
Show Meta Data

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

Line: 171

Function docs


Returns a specific value, if for all linked needs a given option has a given value.

The linked needs can be filtered by using the ``filter`` option.

If ``one_hit`` is set to True, only one linked need must have a positive match for the searched value.

**Examples**

**Needs used as input data**

.. need-example::

.. req:: Input A
:id: clv_A
:status: in progress

.. req:: Input B
:id: clv_B
:status: in progress

.. spec:: Input C
:id: clv_C
:status: closed

**Example 1: Positive check**

Status gets set to *progress*.

.. need-example::

.. spec:: result 1: Positive check
:links: clv_A, clv_B
:status: [[check_linked_values('progress', 'status', 'in progress' )]]
:collapse: False

**Example 2: Negative check**

Status gets not set to *progress*, because status of linked need *clv_C* does not match *"in progress"*.

.. need-example::

.. spec:: result 2: Negative check
:links: clv_A, clv_B, clv_C
:status: [[check_linked_values('progress', 'status', 'in progress' )]]
:collapse: False

**Example 3: Positive check thanks of used filter**

status gets set to *progress*, because linked need *clv_C* is not part of the filter.

.. need-example::

.. spec:: result 3: Positive check thanks of used filter
:links: clv_A, clv_B, clv_C
:status: [[check_linked_values('progress', 'status', 'in progress', 'type == "req" ' )]]
:collapse: False

**Example 4: Positive check thanks of one_hit option**

Even *clv_C* has not the searched status, status gets anyway set to *progress*.
That's because ``one_hit`` is used so that only one linked need must have the searched
value.

.. need-example::

.. spec:: result 4: Positive check thanks of one_hit option
:links: clv_A, clv_B, clv_C
:status: [[check_linked_values('progress', 'status', 'in progress', one_hit=True )]]
:collapse: False

**Result 5: Two checks and a joint status**
Two checks are performed and both are positive. So their results get joined.

.. need-example::

.. spec:: result 5: Two checks and a joint status
:links: clv_A, clv_B, clv_C
:status: [[check_linked_values('progress', 'status', 'in progress', one_hit=True )]] [[check_linked_values('closed', 'status', 'closed', one_hit=True )]]
:collapse: False

:param result: value, which gets returned if all linked needs have parsed the checks
:param search_option: option name, which is used n linked needs for the search
:param search_value: value, which an option of a linked need must match
:param filter_string: Checks are only performed on linked needs, which pass the defined filter
:param one_hit: If True, only one linked need must have a positive check
:return: result, if all checks are positive

copy
(dyn_func, user)

Amount 21.00000
Overall [s] 0.00139
Average [s] 0.00007
Min [s] 0.00000
Max [s] 0.00135
Min-Max spread [%] 226813.60969
Ratio build time [%] 0.00
Max run analysis

Max: 0.0013518089999706717

args

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

kwargs

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

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

Line: 73

Function docs


Copies the value of one need option to another

.. need-example::

.. req:: copy-example
:id: copy_1
:tags: tag_1, tag_2, tag_3
:status: open

.. spec:: copy-example implementation
:id: copy_2
:status: [[copy("status", "copy_1")]]
:links: copy_1
:comment: [[copy("id")]]

Copies status of ``copy_1`` to own status.
Sets also a comment, which copies the id of own need.

.. test:: test of specification and requirement
:id: copy_3
:links: copy_2; [[copy('links', 'copy_2')]]
:tags: [[copy('tags', 'copy_1')]]

Set own link to ``copy_2`` and also copies all links from it.

Also copies all tags from copy_1.

If the filter_string needs to compare a value from the current need and the value is unknown yet,
you can reference the valued field by using ``current_need["my_field"]`` inside the filter string.
Small example::

.. test:: test of current_need value
:id: copy_4

The following copy command copies the title of the first need found under the same highest
section (headline):

:ndf:`copy('title', filter='current_need["sections"][-1]==sections[-1]')`

.. test:: test of current_need value
:id: copy_4

The following copy command copies the title of the first need found under the same highest
section (headline):

:ndf:`copy('title', filter='current_need["sections"][-1]==sections[-1]')`

:param option: Name of the option to copy
:param need_id: id of the need, which contains the source option. If None, current need is taken
:param upper: Is set to True, copied value will be uppercase
:param lower: Is set to True, copied value will be lowercase
:param filter: :ref:`filter_string`, which first result is used as copy source.
:return: string of copied need option

echo
(dyn_func, user)

Amount 2.00000
Overall [s] 0.00000
Average [s] 0.00000
Min [s] 0.00000
Max [s] 0.00000
Min-Max spread [%] 177.95455
Ratio build time [%] 0.00
Max run analysis

Max: 1.5660000372008653e-06

args

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

kwargs

{}
Show Meta Data

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

Line: 51

Function docs


.. versionadded:: 0.6.3

Just returns the given string back.
Mostly useful for tests.

.. need-example::

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

filter_needs
(filtering, internal)

Amount 35.00000
Overall [s] 0.04334
Average [s] 0.00124
Min [s] 0.00002
Max [s] 0.01290
Min-Max spread [%] 59835.18665
Ratio build time [%] 0.04
Max run analysis

Max: 0.012903457999982493

args

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

kwargs

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

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

Line: 490

Function docs


Filters given needs based on a given filter string.
Returns all needs, which pass the given filter.

:param needs: list of needs, which shall be filtered
:param config: NeedsSphinxConfig object
:param filter_string: strings, which gets evaluated against each need
:param current_need: current need, which uses the filter.
:param location: source location for error reporting (docname, line number)
:param append_warning: additional text to append to any failed filter warning

:return: list of found needs

filter_single_need
(filtering, internal)

Amount 4907.00000
Overall [s] 0.02963
Average [s] 0.00001
Min [s] 0.00000
Max [s] 0.00021
Min-Max spread [%] 9210.78942
Ratio build time [%] 0.02
Max run analysis

Max: 0.00020659799997702066

args

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

kwargs

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

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

Line: 553

Function docs


Checks if a single need/need_part passes a filter_string

:param need: the data for a single need
:param config: NeedsSphinxConfig object
:param filter_string: string, which is used as input for eval()
:param needs: list of all needs
:param current_need: set the current_need in the filter context as this, otherwise the need itself
:param filter_compiled: An already compiled filter_string to save time
:param origin_docname: The origin docname that the filter was called from, if any

:return: True, if need passes the filter_string, else False

links_from_content
(dyn_func, user)

Amount 2.00000
Overall [s] 0.00024
Average [s] 0.00012
Min [s] 0.00002
Max [s] 0.00022
Min-Max spread [%] 1246.06291
Ratio build time [%] 0.00
Max run analysis

Max: 0.00022027900001830858

args

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

kwargs

{}
Show Meta Data

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

Line: 404

Function docs


Extracts links from content of a need.

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

Same links are only added once.

Example:

.. req:: Requirement 1
:id: CON_REQ_1

.. req:: Requirement 2
:id: CON_REQ_2

.. spec:: Test spec
:id: CON_SPEC_1
:links: [[links_from_content()]]

This specification cares about the realisation of:

* :need:`CON_REQ_1`
* :need:`My need `

.. spec:: Test spec 2
:id: CON_SPEC_2
:links: [[links_from_content('CON_SPEC_1')]]

Links retrieved from content of :need:`CON_SPEC_1`

Used code of **CON_SPEC_1**::

.. spec:: Test spec
:id: CON_SPEC_1
:links: [[links_from_content()]]

This specification cares about the realisation of:

* :need:`CON_REQ_1`
* :need:`CON_REQ_2`

.. spec:: Test spec 2
:id: CON_SPEC_2
:links: [[links_from_content('CON_SPEC_1')]]

Links retrieved from content of :need:`CON_SPEC_1`

:param need_id: ID of need, which provides the content. If not set, current need is used.
:param filter: :ref:`filter_string`, which a found need-link must pass.
:return: List of linked need-ids in content

post_process_needs_data
(need_post_process, internal)

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

Max: 0.08433432999993329

args

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

kwargs

{}
Show Meta Data

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

Line: 291

Function docs

In-place post-processing of needs data.

This should be called after all needs (and extend) data has been collected.

This function is idempotent;
it will only be run on the first call, and will not be run again.

After this function has been run, one should assume that the needs data is finalised,
and so in principle should be treated as read-only.

process_needflow_graphviz
(needflow_graphviz, internal)

Amount 2.00000
Overall [s] 0.00565
Average [s] 0.00283
Min [s] 0.00087
Max [s] 0.00478
Min-Max spread [%] 550.82891
Ratio build time [%] 0.00
Max run analysis

Max: 0.004783222000014575

args

['<sphinx.application.Sphinx object at 0x731017bfbe10>', '<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/1427/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.02059
Average [s] 0.00343
Min [s] 0.00060
Max [s] 0.00874
Min-Max spread [%] 1445.10762
Ratio build time [%] 0.02
Max run analysis

Max: 0.008736427000030744

args

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

Line: 184

Function docs

None

process_needpie
(needpie, internal)

Amount 2.00000
Overall [s] 0.32098
Average [s] 0.16049
Min [s] 0.03117
Max [s] 0.28981
Min-Max spread [%] 929.76408
Ratio build time [%] 0.27
Max run analysis

Max: 0.28980961000002026

args

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

Line: 111

Function docs

None

process_needtables
(needtable, internal)

Amount 7.00000
Overall [s] 4.63589
Average [s] 0.66227
Min [s] 0.02016
Max [s] 3.83028
Min-Max spread [%] 18998.94398
Ratio build time [%] 3.85
Max run analysis

Max: 3.830279250999979

args

['<sphinx.application.Sphinx object at 0x731017bfbe10>', '<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/1427/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.09321
Average [s] 0.03107
Min [s] 0.00260
Max [s] 0.05780
Min-Max spread [%] 2226.51140
Ratio build time [%] 0.08
Max run analysis

Max: 0.05779629500000283

args

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

Line: 504

Function docs

None

run
(need, internal)

Amount 212.00000
Overall [s] 0.11384
Average [s] 0.00054
Min [s] 0.00000
Max [s] 0.00481
Min-Max spread [%] 383219.02297
Ratio build time [%] 0.09
Max run analysis

Max: 0.004813230999957341

args

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

kwargs

{}
Show Meta Data

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

Line: 57

Function docs

None

run
(needflow, internal)

Amount 35.00000
Overall [s] 0.00247
Average [s] 0.00007
Min [s] 0.00004
Max [s] 0.00019
Min-Max spread [%] 489.07193
Ratio build time [%] 0.00
Max run analysis

Max: 0.0001920830000017304

args

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

kwargs

{}
Show Meta Data

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

Max: 0.0023564470000110305

args

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

kwargs

{}
Show Meta Data

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

Line: 53

Function docs

None

test
(dyn_func, user)

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

Max: 7.440999979735352e-06

args

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

kwargs

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

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

Line: 27

Function docs


Test function for dynamic functions in sphinx needs.

Collects every given args and kwargs and returns a single string, which contains their values/keys.

.. need-example::

.. req:: test requirement

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

:return: single test string