Skip to content

Commit

Permalink
Improve the tables of content (#1852)
Browse files Browse the repository at this point in the history
  • Loading branch information
akukanov authored Sep 20, 2024
1 parent 6d1696e commit b73422d
Show file tree
Hide file tree
Showing 9 changed files with 22 additions and 17 deletions.
1 change: 1 addition & 0 deletions documentation/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ oneAPI DPC++ Library (oneDPL)

.. toctree::
:maxdepth: 2
:titlesonly:

release_notes.rst
library_guide/overview.rst
Expand Down
9 changes: 4 additions & 5 deletions documentation/library_guide/api_for_sycl_kernels_main.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
API for the SYCL* Kernels
#########################
API for SYCL* Kernels
#####################

|onedpl_long| (|onedpl_short|) includes the following APIs for SYCL* kernels:

Expand All @@ -13,9 +13,8 @@ API for the SYCL* Kernels
.. toctree::
:maxdepth: 2
:titlesonly:
:glob:
:hidden:

api_for_sycl_kernels/random
api_for_sycl_kernels/tested_standard_cpp_api
api_for_sycl_kernels/utility_function_object_classes
api_for_sycl_kernels/random
api_for_sycl_kernels/utility_function_object_classes
Original file line number Diff line number Diff line change
Expand Up @@ -125,7 +125,6 @@ More detailed information about the API is provided in the following sections:
.. toctree::
:maxdepth: 2
:titlesonly:
:glob:

fixed_resource_policy
round_robin_policy
Expand Down
1 change: 0 additions & 1 deletion documentation/library_guide/dynamic_selection_api_main.rst
Original file line number Diff line number Diff line change
Expand Up @@ -86,7 +86,6 @@ More detailed information about the API is provided in the following sections:
.. toctree::
:maxdepth: 2
:titlesonly:
:glob:

dynamic_selection_api/functions
dynamic_selection_api/policies
17 changes: 14 additions & 3 deletions documentation/library_guide/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,24 +10,35 @@ For general information, refer to the `oneDPL GitHub* repository

.. toctree::
:maxdepth: 2
:titlesonly:
:caption: Get Started

introduction/release_notes.rst
introduction/onedpl_gsg.rst

.. toctree::
:maxdepth: 2
:caption: Library Guide
:titlesonly:
:includehidden:
:caption: Core Functionality

introduction
parallel_api_main
api_for_sycl_kernels_main
dynamic_selection_api_main
kernel_templates_main
macros
cmake_support
oneDPL_2022.0_changes

.. toctree::
:maxdepth: 1
:titlesonly:
:includehidden:
:caption: Technology Preview

parallel_api/async_api
dynamic_selection_api_main
kernel_templates_main

.. toctree::
:hidden:
:caption: Notices and Disclaimers
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,6 @@ These templates are available in the ``oneapi::dpl::experimental::kt::gpu::esimd
.. toctree::
:maxdepth: 2
:titlesonly:
:glob:
:hidden:

esimd/radix_sort
Expand Down
1 change: 0 additions & 1 deletion documentation/library_guide/kernel_templates_main.rst
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,6 @@ The primary API namespace is ``oneapi::dpl::experimental::kt``, and nested names
.. toctree::
:maxdepth: 2
:titlesonly:
:glob:
:hidden:

kernel_templates/kernel_configuration
Expand Down
4 changes: 2 additions & 2 deletions documentation/library_guide/parallel_api/async_api.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
Asynchronous API Algorithms
###########################
Asynchronous Algorithms
#######################

The functions defined in the STL ``<algorithm>`` or ``<numeric>`` headers are traditionally blocking. |onedpl_long| (|onedpl_short|)
extends the functionality of the C++17 parallel algorithms by providing asynchronous algorithms with non-blocking behavior.
Expand Down
4 changes: 1 addition & 3 deletions documentation/library_guide/parallel_api_main.rst
Original file line number Diff line number Diff line change
Expand Up @@ -28,13 +28,11 @@ that may be passed to algorithms such as reduce or transform.
.. toctree::
:maxdepth: 2
:titlesonly:
:glob:
:hidden:

parallel_api/execution_policies
parallel_api/iterators
parallel_api/parallel_range_algorithms
parallel_api/additional_algorithms
parallel_api/pass_data_algorithms
parallel_api/async_api
parallel_api/iterators
parallel_api/range_based_api

0 comments on commit b73422d

Please sign in to comment.