Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
21 changes: 20 additions & 1 deletion doc/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,11 @@

BUILD_TYPE = os.getenv("BUILD_TYPE")

# Set up tags for conditional content
# Tags allow using .. only:: directives in RST files
if BUILD_TYPE == 'oss' or BUILD_TYPE is None:
tags.add('oss')

# -- Project information -----------------------------------------------------

if BUILD_TYPE == 'oneapi' or BUILD_TYPE == 'dita':
Expand Down Expand Up @@ -83,7 +88,19 @@
# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
# This pattern also affects html_static_path and html_extra_path.
exclude_patterns = []
# Base exclude patterns - specification files that should never be built
exclude_patterns = [
'main/specification/source/nested-*.rst',
'main/specification/source/uncategorized.rst',
'main/specification/source/uncategorized/**',
'main/specification/source/low_level_task_api.rst',
'main/specification/source/low_level_tasking/**',
]

# Specification is only included in OSS builds (GitHub Pages)
# Intel builds (oneapi/dita) automatically exclude the entire specification directory
if BUILD_TYPE == 'oneapi' or BUILD_TYPE == 'dita':
exclude_patterns.append('main/specification/**')

# The name of the Pygments (syntax highlighting) style to use.
pygments_style = None
Expand All @@ -96,6 +113,7 @@
.. |full_name| replace:: Intel\ |reg|\ oneAPI Threading Building Blocks (oneTBB)
.. |short_name| replace:: oneTBB
.. |product| replace:: oneTBB
.. |tbb_version| replace:: 1.5
.. |reg| unicode:: U+000AE
.. |copy| unicode:: U+000A9
.. |base_tk| replace:: Intel\ |reg|\ oneAPI Base Toolkit
Expand All @@ -106,6 +124,7 @@
.. |full_name| replace:: oneAPI Threading Building Blocks (oneTBB)
.. |short_name| replace:: oneTBB
.. |product| replace:: oneTBB
.. |tbb_version| replace:: 1.5
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If we decide to keep it, I'd recommend renaming it to tbb_spec_version to avoid misunderstanding.

.. |reg| unicode:: U+000AE
.. |copy| unicode:: U+000A9
.. |base_tk| replace:: Intel\ |reg|\ oneAPI Base Toolkit
Expand Down
8 changes: 8 additions & 0 deletions doc/index/toctree.rst
Original file line number Diff line number Diff line change
Expand Up @@ -40,3 +40,11 @@
:caption: Developer Reference

/main/reference/reference


.. toctree::
:maxdepth: 3
:hidden:
:caption: Specification

/main/specification/source/index
13 changes: 9 additions & 4 deletions doc/main/reference/reference.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,14 +3,19 @@
|short_name| API Reference
==========================

For oneTBB API Reference, refer to `oneAPI Specification <https://github.com/uxlfoundation/oneAPI-spec>`_. The current supported
version of oneAPI Specification is 1.0.
.. only:: oss

For oneTBB API Reference, refer to the :doc:`oneTBB Specification </main/specification/source/index>`.

.. only:: not oss

For oneTBB API Reference, refer to the `oneTBB Specification <https://uxlfoundation.github.io/oneTBB/main/specification/source/index.html>`_.
The current supported version of the oneTBB specification is 1.5.
Comment on lines +10 to +13
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do we need this?


Specification extensions
************************

|full_name| implements the `oneTBB specification <https://oneapi-spec.uxlfoundation.org/specifications/oneapi/latest/elements/onetbb/source/nested-index>`_.
This document provides additional details or restrictions where necessary.
|full_name| implements the oneTBB specification. This document provides additional details or restrictions beyond the specification.
It also describes features that are not included in the oneTBB specification.

.. toctree::
Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
66 changes: 66 additions & 0 deletions doc/main/specification/source/algorithms.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,66 @@
.. SPDX-FileCopyrightText: 2019-2021 Intel Corporation
..
.. SPDX-License-Identifier: CC-BY-4.0

==========
Algorithms
==========
**[algorithms]**

oneAPI Threading Building Blocks provides a set of generic parallel algorithms.

Parallel Functions
------------------

.. toctree::
:titlesonly:

algorithms/functions/collaborative_call_once_func.rst

algorithms/functions/parallel_for_func.rst
algorithms/functions/parallel_reduce_func.rst
algorithms/functions/parallel_deterministic_reduce_func.rst
algorithms/functions/parallel_scan_func.rst

algorithms/functions/parallel_for_each_func.rst

algorithms/functions/parallel_invoke_func.rst
algorithms/functions/parallel_pipeline_func.rst
algorithms/functions/parallel_sort_func.rst

Blocked Ranges
--------------

Types that meet the :doc:`Range requirements <named_requirements/algorithms/range>`.

.. toctree::
:titlesonly:

algorithms/blocked_ranges/blocked_range_cls.rst
algorithms/blocked_ranges/blocked_range2d_cls.rst
algorithms/blocked_ranges/blocked_range3d_cls.rst
algorithms/blocked_ranges/blocked_nd_range_cls.rst

.. _Partitioners:

Partitioners
------------

A partitioner specifies how a loop template should partition its work among threads.

.. toctree::
:titlesonly:

algorithms/partitioners/auto_partitioner.rst
algorithms/partitioners/affinity_partitioner.rst
algorithms/partitioners/static_partitioner.rst
algorithms/partitioners/simple_partitioner.rst

Split Tags
----------

.. toctree::
:titlesonly:

algorithms/split_tags/proportional_split_cls.rst
algorithms/split_tags/split_cls.rst
Loading
Loading