Skip to content

Commit 4e021ea

Browse files
authored
Complete documentation update (#599)
Signed-off-by: Olga Malysheva <[email protected]>
1 parent 84da9e9 commit 4e021ea

File tree

5 files changed

+8
-12
lines changed

5 files changed

+8
-12
lines changed

doc/main/conf.py

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@
2525

2626
# -- Project information -----------------------------------------------------
2727

28-
if BUILD_TYPE == 'oneapi':
28+
if BUILD_TYPE == 'oneapi' or BUILD_TYPE == 'dita':
2929
project = u'Intel® oneAPI Threading Building Blocks (oneTBB)'
3030
else:
3131
project = u'oneAPI Threading Building Blocks (oneTBB)'
@@ -90,7 +90,7 @@
9090
# Syntax highlighting for the :: directive
9191
highlight_language = 'cpp'
9292

93-
if BUILD_TYPE == 'oneapi':
93+
if BUILD_TYPE == 'oneapi' or BUILD_TYPE == 'dita':
9494
rst_prolog = """
9595
.. |full_name| replace:: Intel\ |reg|\ oneAPI Threading Building Blocks (oneTBB)
9696
.. |short_name| replace:: oneTBB
@@ -120,7 +120,7 @@
120120
# further. For a list of options available for each theme, see the
121121
# documentation.
122122
#
123-
if BUILD_TYPE == 'oneapi':
123+
if BUILD_TYPE == 'oneapi' or BUILD_TYPE == 'dita':
124124
html_theme = 'sphinx_rtd_theme'
125125
else:
126126
html_theme = 'sphinx_book_theme'
@@ -140,7 +140,7 @@
140140
# so a file named "default.css" will overwrite the builtin "default.css".
141141
html_static_path = ['_static']
142142

143-
if BUILD_TYPE == 'oneapi':
143+
if BUILD_TYPE == 'oneapi' or BUILD_TYPE == 'dita':
144144
html_context = {
145145
'css_files': [
146146
'_static/theme_overrides.css', # override wide tables in RTD theme

doc/main/tbb_userguide/Data_Flow_Graph.rst

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -191,8 +191,7 @@ This final implementation has all of the nodes and edges from the
191191
much advantage in using an ``input_node`` over an explicit loop. But,
192192
because an ``input_node`` is able to react to the behavior of downstream
193193
nodes, it can limit memory use in more complex graphs. For more
194-
information, see `Creating a Token-Based
195-
System <create_token_based_system.html#create_token_based_system>`__
194+
information, see:ref:`create_token_based_system` .
196195

197196

198197
.. |image0| image:: Images/flow_graph.jpg

doc/main/tbb_userguide/destroy_graphs_outside_main_thread.rst

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,7 @@ You may not always want to block the main application thread by calling
99
wait_for_all(). However, it is safest to call wait_for_all on a graph
1010
before destroying it. A common solution is to enqueue a task to build
1111
and wait for the graph to complete. For example, assume you really do
12-
not want to call a wait_for_all in the example from `Always Use
13-
wait_for_all() <always_use_wait_for_all.html#always_use_wait4all>`__,
12+
not want to call a wait_for_all in the example from :ref:`always_use_wait_for_all`,
1413
Instead you can enqueue a task that creates the graph and waits for it:
1514

1615

doc/main/tbb_userguide/use_graph_reset.rst

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,7 @@ Use graph::reset() to Reset a Canceled Graph
77
When a graph execution is canceled either because of an unhandled
88
exception or because its task_group_context is canceled explicitly, the
99
graph and its nodes may be left in an indeterminate state. For example,
10-
in the code samples shown in `Cancel a Graph
11-
Explicitly <cancel_a_graph.html#cancel_a_graph>`__ the input 2 may be
10+
in the code samples shown in :ref:`cancel_a_graph` the input 2 may be
1211
left in a buffer. But even beyond remnants in the buffers, there are
1312
other optimizations performed during the execution of a flow graph that
1413
can leave its nodes and edges in an indeterminate state. If you want to

doc/main/tbb_userguide/use_input_node.rst

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -29,8 +29,7 @@ All ``input_node`` objects are constructed in the inactive state and usually
2929
activated after the entire flow graph is constructed.
3030

3131

32-
For example, you can use the code in `Data Flow
33-
Graph <Data_Flow_Graph.html#Data_Flow_Graph>`__. In that implementation,
32+
For example, you can use the code in :ref:`Data_Flow_Graph`. In that implementation,
3433
the ``input_node`` is constructed in the inactive state and activated after
3534
all other edges are made:
3635

0 commit comments

Comments
 (0)