Add :titlesonly:, remove :glob:, comment out hidden subtrees

uxlfoundation · Sep 17, 2024 · 89b1cd7 · 89b1cd7
1 parent c4c7c27
commit 89b1cd7
Show file tree

Hide file tree

Showing 8 changed files with 38 additions and 37 deletions.
diff --git 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
@@ -10,12 +10,12 @@ API for the SYCL* Kernels
 * :doc:`Utility Function Object Classes <api_for_sycl_kernels/utility_function_object_classes>`. Various
   utilities in addition to C++ standard functionality.
 
-.. toctree::
-   :maxdepth: 2
-   :titlesonly:
-   :glob:
-   :hidden:
+..
+    .. toctree::
+       :maxdepth: 2
+       :titlesonly:
+       :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/tested_standard_cpp_api
+       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
@@ -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
@@ -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
@@ -10,13 +10,15 @@ 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
+   :titlesonly:
    :caption: Library Guide
 
    introduction

diff --git a/documentation/library_guide/kernel_templates/esimd_main.rst b/documentation/library_guide/kernel_templates/esimd_main.rst
@@ -9,14 +9,14 @@ These templates are available in the ``oneapi::dpl::experimental::kt::gpu::esimd
 * :doc:`radix_sort <esimd/radix_sort>`
 * :doc:`radix_sort_by_key <esimd/radix_sort_by_key>`
 
-.. toctree::
-   :maxdepth: 2
-   :titlesonly:
-   :glob:
-   :hidden:
-
-   esimd/radix_sort
-   esimd/radix_sort_by_key
+..
+    .. toctree::
+       :maxdepth: 2
+       :titlesonly:
+       :hidden:
+
+       esimd/radix_sort
+       esimd/radix_sort_by_key
 
 -------------------
 System Requirements

diff --git a/documentation/library_guide/kernel_templates_main.rst b/documentation/library_guide/kernel_templates_main.rst
@@ -17,12 +17,12 @@ The primary API namespace is ``oneapi::dpl::experimental::kt``, and nested names
 * :doc:`ESIMD-based kernel templates <kernel_templates/esimd_main>`. Algorithms implemented with the Explicit SIMD SYCL extension.
 * :doc:`Inclusive scan algorithm <kernel_templates/single_pass_scan>`. Inclusive scan kernel template algorithm using a single-pass approach.
 
-.. toctree::
-   :maxdepth: 2
-   :titlesonly:
-   :glob:
-   :hidden:
+..
+    .. toctree::
+       :maxdepth: 2
+       :titlesonly:
+       :hidden:
 
-   kernel_templates/kernel_configuration
-   kernel_templates/esimd_main
-   kernel_templates/single_pass_scan
+       kernel_templates/kernel_configuration
+       kernel_templates/esimd_main
+       kernel_templates/single_pass_scan
diff --git a/documentation/library_guide/parallel_api_main.rst b/documentation/library_guide/parallel_api_main.rst
@@ -23,15 +23,15 @@ that may be passed to algorithms such as reduce or transform.
 |onedpl_short| also includes an experimental implementation of range-based algorithms with their
 required ranges, and experimental asynchronous algorithms.
 
-.. toctree::
-   :maxdepth: 2
-   :titlesonly:
-   :glob:
-   :hidden:
+..
+    .. toctree::
+       :maxdepth: 2
+       :titlesonly:
+       :hidden:
 
-   parallel_api/execution_policies
-   parallel_api/iterators
-   parallel_api/async_api
-   parallel_api/range_based_api
-   parallel_api/additional_algorithms
-   parallel_api/pass_data_algorithms
+       parallel_api/execution_policies
+       parallel_api/iterators
+       parallel_api/async_api
+       parallel_api/range_based_api
+       parallel_api/additional_algorithms
+       parallel_api/pass_data_algorithms