diff --git a/documentation/index.rst b/documentation/index.rst index e92e9653838..5078730a4b2 100644 --- a/documentation/index.rst +++ b/documentation/index.rst @@ -3,6 +3,7 @@ oneAPI DPC++ Library (oneDPL) .. toctree:: :maxdepth: 2 + :titlesonly: release_notes.rst library_guide/overview.rst diff --git a/documentation/library_guide/api_for_sycl_kernels_main.rst b/documentation/library_guide/api_for_sycl_kernels_main.rst index 333f9e24c29..2a9aad44a78 100644 --- a/documentation/library_guide/api_for_sycl_kernels_main.rst +++ b/documentation/library_guide/api_for_sycl_kernels_main.rst @@ -1,5 +1,5 @@ -API for the SYCL* Kernels -######################### +API for SYCL* Kernels +##################### |onedpl_long| (|onedpl_short|) includes the following APIs for SYCL* kernels: @@ -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 \ No newline at end of file + api_for_sycl_kernels/random + api_for_sycl_kernels/utility_function_object_classes diff --git a/documentation/library_guide/dynamic_selection_api/policies.rst b/documentation/library_guide/dynamic_selection_api/policies.rst index f74a2f0dca7..7db86f5a876 100644 --- a/documentation/library_guide/dynamic_selection_api/policies.rst +++ b/documentation/library_guide/dynamic_selection_api/policies.rst @@ -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 diff --git a/documentation/library_guide/dynamic_selection_api_main.rst b/documentation/library_guide/dynamic_selection_api_main.rst index 2b3f18d97a6..b200594d9ff 100644 --- a/documentation/library_guide/dynamic_selection_api_main.rst +++ b/documentation/library_guide/dynamic_selection_api_main.rst @@ -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 diff --git a/documentation/library_guide/index.rst b/documentation/library_guide/index.rst index eb0588e0928..f460357ad1f 100644 --- a/documentation/library_guide/index.rst +++ b/documentation/library_guide/index.rst @@ -10,6 +10,7 @@ For general information, refer to the `oneDPL GitHub* repository .. toctree:: :maxdepth: 2 + :titlesonly: :caption: Get Started introduction/release_notes.rst @@ -17,17 +18,27 @@ For general information, refer to the `oneDPL GitHub* repository .. 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 diff --git a/documentation/library_guide/kernel_templates/esimd_main.rst b/documentation/library_guide/kernel_templates/esimd_main.rst index 82064672527..00387ec08fa 100644 --- a/documentation/library_guide/kernel_templates/esimd_main.rst +++ b/documentation/library_guide/kernel_templates/esimd_main.rst @@ -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 diff --git a/documentation/library_guide/kernel_templates_main.rst b/documentation/library_guide/kernel_templates_main.rst index 1c33fd91eea..108e54221f4 100644 --- a/documentation/library_guide/kernel_templates_main.rst +++ b/documentation/library_guide/kernel_templates_main.rst @@ -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 diff --git a/documentation/library_guide/parallel_api/async_api.rst b/documentation/library_guide/parallel_api/async_api.rst index 5c16422d13f..242b30c92ac 100644 --- a/documentation/library_guide/parallel_api/async_api.rst +++ b/documentation/library_guide/parallel_api/async_api.rst @@ -1,5 +1,5 @@ -Asynchronous API Algorithms -########################### +Asynchronous Algorithms +####################### The functions defined in the STL ```` or ```` 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. diff --git a/documentation/library_guide/parallel_api_main.rst b/documentation/library_guide/parallel_api_main.rst index 3191849fbd8..5c78c6f46f2 100644 --- a/documentation/library_guide/parallel_api_main.rst +++ b/documentation/library_guide/parallel_api_main.rst @@ -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