From ce0d258e7240fa5951d0034b46967dd10c1cfbca Mon Sep 17 00:00:00 2001 From: Alexandra Date: Wed, 2 Mar 2022 18:37:52 +0300 Subject: [PATCH] Update doc structure and add new files (#791) --- doc/GSG/examples.rst | 32 +++++++++++++++++++++++ doc/GSG/installation.rst | 7 +++++ doc/conf.py | 2 +- doc/index/index_intro.rst | 1 + doc/index/toctree.rst | 36 ++++++++++++++++++++------ doc/main/intro/introducing_main_os.rst | 30 --------------------- 6 files changed, 69 insertions(+), 39 deletions(-) create mode 100644 doc/GSG/examples.rst create mode 100644 doc/GSG/installation.rst delete mode 100644 doc/main/intro/introducing_main_os.rst diff --git a/doc/GSG/examples.rst b/doc/GSG/examples.rst new file mode 100644 index 0000000000..4a1b55ab24 --- /dev/null +++ b/doc/GSG/examples.rst @@ -0,0 +1,32 @@ +.. _examples: + +oneTBB Samples +============== + +Refer to the following examples to see how |short_name| works. + +* `concurrent_hash_map `_ +* `concurrent_priority_queue `_ +* `Flow Graph `_ + * `A solution to the binpacking problem using a queue_node, a buffer_node, and function_node. `_ + * `Cholesky Factorization algorithm `_ + * `An implementation of dining philosophers in graph using the reserving join_node `_ + * `A parallel implementation of bzip2 block-sorting file compressor `_ + * `An example of a collection of digital logic gates that can be easily composed into larger circuits `_ + * `An example of a Kohonen Self-Organizing Map using cancellation `_ + * `Split computational kernel for execution between CPU and GPU `_ +* `parallel_for `_ + * `Game of life overlay `_ + * `Polygon overlay `_ + * `Parallel seismic wave simulation `_ + * `Parallel 2-D raytracer/renderer `_ + * `Find largest matching substrings `_ + * `Resumable task: Split computational kernel for execution between CPU and GPU `_ +* `parallel_for_each `_ +* `parallel_pipeline `_ +* `parallel_reduce `_ +* `task_arena `_ +* `task_group `_ +* `Compute Fibonacci numbers in different ways `_ +* `Execute similar computational kernels, with one task executing the SYCL* code and the other task executing the oneTBB code `_ + diff --git a/doc/GSG/installation.rst b/doc/GSG/installation.rst new file mode 100644 index 0000000000..e6b6a09c34 --- /dev/null +++ b/doc/GSG/installation.rst @@ -0,0 +1,7 @@ +.. _installation: + +Installation +============ + +See the `installation instructions `_ +that will help you to install |short_name| successfully. \ No newline at end of file diff --git a/doc/conf.py b/doc/conf.py index 2fd617f5ac..e57262c23b 100644 --- a/doc/conf.py +++ b/doc/conf.py @@ -29,7 +29,7 @@ project = u'Intel® oneAPI Threading Building Blocks (oneTBB)' else: project = u'oneTBB' -copyright = u'2021, Intel Corporation' +copyright = u'2022, Intel Corporation' author = u'Intel' # The short X.Y version diff --git a/doc/index/index_intro.rst b/doc/index/index_intro.rst index b82c487997..72055fe8d3 100644 --- a/doc/index/index_intro.rst +++ b/doc/index/index_intro.rst @@ -2,3 +2,4 @@ This document contains information about |short_name|. It is a flexible performance library that let you break computation into parallel running tasks. + diff --git a/doc/index/toctree.rst b/doc/index/toctree.rst index 364d52aefc..60cfe1e362 100644 --- a/doc/index/toctree.rst +++ b/doc/index/toctree.rst @@ -1,13 +1,33 @@ .. _toctree: .. toctree:: + :caption: About + :maxdepth: 1 + + /main/intro/help_support + /main/intro/notation + /main/intro/intro_os + /main/intro/Benefits + + +.. toctree:: + :caption: Get Started :maxdepth: 2 - main/intro/help_support - main/intro/notation - main/intro/intro_os - main/intro/Benefits - GSG/get_started - main/tbb_userguide/title - main/reference/reference - main/intro/notices_and_disclaimers \ No newline at end of file + /GSG/get_started + /GSG/installation + /GSG/examples + + +.. toctree:: + :maxdepth: 3 + :caption: Developer Guide + + /main/tbb_userguide/title + + +.. toctree:: + :maxdepth: 3 + :caption: Developer Reference + + /main/reference/reference diff --git a/doc/main/intro/introducing_main_os.rst b/doc/main/intro/introducing_main_os.rst deleted file mode 100644 index 0d6a1be95f..0000000000 --- a/doc/main/intro/introducing_main_os.rst +++ /dev/null @@ -1,30 +0,0 @@ -.. _introducing_main: - -Introduction -============ - - -|full_name| is a library that supports scalable parallel programming using -standard ISO C++ code. It does not require special languages or -compilers. It is designed to promote scalable data parallel programming. -Additionally, it fully supports nested parallelism, so you can build -larger parallel components from smaller parallel components. To use the -library, you specify tasks, not threads, and let the library map tasks -onto threads in an efficient manner. - - -Many of the library interfaces employ generic programming, in which -interfaces are defined by requirements on types and not specific types. -The C++ Standard Template Library (STL) is an example of generic -programming. Generic programming enables oneTBB to be flexible yet -efficient. The generic interfaces enable you to customize components to -your specific needs. - - -.. note:: - |full_name| requires C++11 standard compiler support. - - -The net result is that oneTBB enables you to specify parallelism far -more conveniently than using raw threads, and at the same time can -improve performance. \ No newline at end of file