Doc reorg for diataxis (#513)

* doc_reorg

* additional edits

* _toc.yml.in update

* review comments implemented

LICENSE.txt

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2017-2022 Advanced Micro Devices, Inc. All rights reserved.
+Copyright (c) 2017-2024 Advanced Micro Devices, Inc. All rights reserved.
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

docs/block_ops/data_mov_funcs.rst

@@ -1,62 +1,69 @@
-Data movement functions
------------------------
+.. meta::
+  :description: rocPRIM documentation and API reference library
+  :keywords: rocPRIM, ROCm, API, documentation
+
+.. _data_mov_funcs:
+
+********************************************************************
+ Data movement functions
+********************************************************************
 
 Direct Blocked
-~~~~~~~~~~~~~~
+===============
 
 Load
-....
+------
 
 .. doxygenfunction:: rocprim::block_load_direct_blocked(unsigned int flat_id, InputIterator block_input, T (&items)[ItemsPerThread])
 .. doxygenfunction:: rocprim::block_load_direct_blocked(unsigned int flat_id, InputIterator block_input, T (&items)[ItemsPerThread], unsigned int valid)
 .. doxygenfunction:: rocprim::block_load_direct_blocked (unsigned int flat_id, InputIterator block_input, T(&items)[ItemsPerThread], unsigned int valid, Default out_of_bounds)
 
 Store
-.....
+----------
 
 .. doxygenfunction:: rocprim::block_store_direct_blocked (unsigned int flat_id, OutputIterator block_output, T(&items)[ItemsPerThread])
 .. doxygenfunction:: rocprim::block_store_direct_blocked (unsigned int flat_id, OutputIterator block_output, T(&items)[ItemsPerThread], unsigned int valid)
 
 Direct Blocked Vectorized
-~~~~~~~~~~~~~~~~~~~~~~~~~
+===========================
 
 Load
-....
+-------
 
 .. doxygenfunction:: rocprim::block_load_direct_blocked_vectorized (unsigned int flat_id, T *block_input, U(&items)[ItemsPerThread])
 
 Store
-.....
+----------
 
 .. doxygenfunction:: rocprim::block_store_direct_blocked_vectorized (unsigned int flat_id, T *block_output, U(&items)[ItemsPerThread])
 
 Direct Striped
-~~~~~~~~~~~~~~
+==================
 
 Load
-....
+---------
 
 .. doxygenfunction:: rocprim::block_load_direct_striped (unsigned int flat_id, InputIterator block_input, T(&items)[ItemsPerThread])
 .. doxygenfunction:: rocprim::block_load_direct_striped (unsigned int flat_id, InputIterator block_input, T(&items)[ItemsPerThread], unsigned int valid)
 .. doxygenfunction:: rocprim::block_load_direct_striped (unsigned int flat_id, InputIterator block_input, T(&items)[ItemsPerThread], unsigned int valid, Default out_of_bounds)
 
 Store
-.....
+----------
 
 .. doxygenfunction:: rocprim::block_store_direct_striped (unsigned int flat_id, OutputIterator block_output, T(&items)[ItemsPerThread])
 .. doxygenfunction:: rocprim::block_store_direct_striped (unsigned int flat_id, OutputIterator block_output, T(&items)[ItemsPerThread], unsigned int valid)
 
 Direct Warp Striped
-~~~~~~~~~~~~~~~~~~~
+====================
 
 Load
-....
+---------
 
 .. doxygengroup:: blockmodule_warp_load_functions
    :content-only:
 
 Store
-.....
+----------
 
 .. doxygengroup:: blockmodule_warp_store_functions
    :content-only:

docs/block_ops/index.rst

@@ -1,6 +1,24 @@
-Block-Wide Operations
-=====================
+.. meta::
+  :description: rocPRIM documentation and API reference library
+  :keywords: rocPRIM, ROCm, API, documentation
 
-.. toctree::
-   ops_classes/index
-   data_mov_funcs
+.. _block-index:
+
+********************************************************************
+ Block-Wide Operations
+********************************************************************
+
+  * :ref:`class-index`
+
+    * :ref:`blk-load`
+    * :ref:`blk-store`
+    * :ref:`blk-adjacent_difference`
+    * :ref:`blk-discontinuity`
+    * :ref:`blk-scan`
+    * :ref:`blk-reduce`
+    * :ref:`blk-shuffle`
+    * :ref:`blk-exchange`
+    * :ref:`blk-sort`
+    * :ref:`blk-histogram`
+
+  * :ref:`data_mov_funcs`

docs/block_ops/ops_classes/adjacent_difference.rst

@@ -1,5 +1,12 @@
-Adjacent difference
-~~~~~~~~~~~~~~~~~~~
+.. meta::
+  :description: rocPRIM documentation and API reference library
+  :keywords: rocPRIM, ROCm, API, documentation
+
+.. _blk-adjacent_difference:
+
+********************************************************************
+ Adjacent difference
+********************************************************************
 
 .. doxygenclass:: rocprim::block_adjacent_difference
    :members:

docs/block_ops/ops_classes/discontinuity.rst

@@ -1,5 +1,12 @@
-Discontinuity
-~~~~~~~~~~~~~
+.. meta::
+  :description: rocPRIM documentation and API reference library
+  :keywords: rocPRIM, ROCm, API, documentation
+
+.. _blk-discontinuity:
+
+********************************************************************
+ Discontinuity
+********************************************************************
 
 .. doxygenclass:: rocprim::block_discontinuity
    :members:

docs/block_ops/ops_classes/exchange.rst

@@ -1,5 +1,12 @@
-Exchange
-~~~~~~~~
+.. meta::
+  :description: rocPRIM documentation and API reference library
+  :keywords: rocPRIM, ROCm, API, documentation
+
+.. _blk-exchange:
+
+********************************************************************
+ Exchange
+********************************************************************
 
 .. doxygenclass:: rocprim::block_exchange
    :members:

docs/block_ops/ops_classes/histogram.rst

@@ -1,12 +1,20 @@
-Histogram
-~~~~~~~~~
+.. meta::
+  :description: rocPRIM documentation and API reference library
+  :keywords: rocPRIM, ROCm, API, documentation
+
+.. _blk-histogram:
+
+********************************************************************
+ Histogram
+********************************************************************
+
 Class
-.....
+=========
 
 .. doxygenclass:: rocprim::block_histogram
    :members:
 
 Algorithms
-..........
+===========
 
 .. doxygenenum:: rocprim::block_histogram_algorithm

docs/block_ops/ops_classes/index.rst

@@ -1,18 +1,20 @@
-Operation classes
------------------
+.. meta::
+  :description: rocPRIM documentation and API reference library
+  :keywords: rocPRIM, ROCm, API, documentation
 
-.. toctree::
-   load
-   store
+.. _class-index:
 
-   adjacent_difference
-   discontinuity
+********************************************************************
+ Operation classes
+********************************************************************
 
-   scan
-   reduce
-
-   shuffle
-   exchange
-   sort
-
-   histogram
+  * :ref:`blk-load`
+  * :ref:`blk-store`
+  * :ref:`blk-adjacent_difference`
+  * :ref:`blk-discontinuity`
+  * :ref:`blk-scan`
+  * :ref:`blk-reduce`
+  * :ref:`blk-shuffle`
+  * :ref:`blk-exchange`
+  * :ref:`blk-sort`
+  * :ref:`blk-histogram`

docs/block_ops/ops_classes/load.rst

@@ -1,13 +1,20 @@
-Load
-~~~~
+.. meta::
+  :description: rocPRIM documentation and API reference library
+  :keywords: rocPRIM, ROCm, API, documentation
+
+.. _blk-load:
+
+********************************************************************
+ Load
+********************************************************************
 
 Class
-.....
+==========
 
 .. doxygenclass:: rocprim::block_load
    :members:
 
 Algorithms
-..........
+==============
 
 .. doxygenenum:: rocprim::block_load_method

docs/block_ops/ops_classes/reduce.rst

@@ -1,13 +1,20 @@
-Reduce
-~~~~~~
+.. meta::
+  :description: rocPRIM documentation and API reference library
+  :keywords: rocPRIM, ROCm, API, documentation
+
+.. _blk-reduce:
+
+********************************************************************
+ Reduce
+********************************************************************
 
 Class
-.....
+==========
 
 .. doxygenclass:: rocprim::block_reduce
    :members:
 
 Algorithms
-..........
+============
 
 .. doxygenenum:: rocprim::block_reduce_algorithm

docs/block_ops/ops_classes/scan.rst

@@ -1,13 +1,20 @@
-Scan
-~~~~
+.. meta::
+  :description: rocPRIM documentation and API reference library
+  :keywords: rocPRIM, ROCm, API, documentation
+
+.. _blk-scan:
+
+********************************************************************
+ Scan
+********************************************************************
 
 Class
-.....
+=======
 
 .. doxygenclass:: rocprim::block_scan
    :members:
 
 Algorithms
-..........
+==============
 
 .. doxygenenum:: rocprim::block_scan_algorithm

docs/block_ops/ops_classes/shuffle.rst

@@ -1,5 +1,12 @@
-Shuffle
-~~~~~~~
+.. meta::
+  :description: rocPRIM documentation and API reference library
+  :keywords: rocPRIM, ROCm, API, documentation
+
+.. _blk-shuffle:
+
+********************************************************************
+ Shuffle
+********************************************************************
 
 .. doxygenclass:: rocprim::block_shuffle
    :members:

docs/block_ops/ops_classes/sort.rst

@@ -1,8 +1,15 @@
-Sort
-~~~~
+.. meta::
+  :description: rocPRIM documentation and API reference library
+  :keywords: rocPRIM, ROCm, API, documentation
+
+.. _blk-sort:
+
+********************************************************************
+ Sort
+********************************************************************
 
 generic
-.......
+=========
 
 
 .. doxygenclass:: rocprim::block_sort
@@ -11,7 +18,7 @@ generic
 .. doxygenenum:: rocprim::block_sort_algorithm
 
 radix sort
-..........
+===========
 
 .. doxygenclass:: rocprim::block_radix_sort
    :members:

docs/block_ops/ops_classes/store.rst

@@ -1,13 +1,20 @@
-Store
-~~~~~
+.. meta::
+  :description: rocPRIM documentation and API reference library
+  :keywords: rocPRIM, ROCm, API, documentation
+
+.. _blk-store:
+
+********************************************************************
+ Store
+********************************************************************
 
 Class
-.....
+======
 
 .. doxygenclass:: rocprim::block_store
    :members:
 
 Algorithms
-..........
+===========
 
 .. doxygenenum:: rocprim::block_store_method

docs/concepts/concepts.rst

@@ -0,0 +1,12 @@
+.. meta::
+  :description: rocPRIM documentation and API reference library
+  :keywords: rocPRIM, ROCm, API, documentation
+
+.. _concepts:
+
+********************************************************************
+ rocPRIM Concepts
+********************************************************************
+
+* :ref:`rocprim-intro`
+* :ref:`glossary`