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

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions docs/Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -4,3 +4,6 @@ html:

clean:
rm -rf ./generated_docs/

linkcheck:
sphinx-build -b linkcheck ./source/ ./generated_docs/ -W --keep-going
5 changes: 1 addition & 4 deletions docs/source/API/algorithms/std-algorithms/all/StdCopyIf.rst
Original file line number Diff line number Diff line change
Expand Up @@ -94,10 +94,7 @@ Overload set accepting a team handle
Parameters and Requirements
~~~~~~~~~~~~~~~~~~~~~~~~~~~

.. |copy| replace:: ``copy``
.. _copy: ./StdCopy.html

- ``exespace``, ``teamHandle``, ``first_from``, ``last_from``, ``first_to``, ``view_from``, ``view_to``: same as in |copy|_
- ``exespace``, ``teamHandle``, ``first_from``, ``last_from``, ``first_to``, ``view_from``, ``view_to``: same as in :doc:`copy <./StdCopy>`

- ``label``:

Expand Down
6 changes: 1 addition & 5 deletions docs/source/API/algorithms/std-algorithms/all/StdCopy_n.rst
Original file line number Diff line number Diff line change
Expand Up @@ -84,11 +84,7 @@ Overload set accepting a team handle
Parameters and Requirements
~~~~~~~~~~~~~~~~~~~~~~~~~~~

.. |copy| replace:: ``copy``
.. _copy: ./StdCopy.html


- ``exespace``, ``teamHandle``, ``first_from``, ``first_to``, ``view_from``, ``view_to``: same as in |copy|_
- ``exespace``, ``teamHandle``, ``first_from``, ``first_to``, ``view_from``, ``view_to``: same as in :doc:`copy <StdCopy>`.

- ``label``: used to name the implementation kernels for debugging purposes

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -95,10 +95,7 @@ Overload set accepting a team handle
Parameters and Requirements
~~~~~~~~~~~~~~~~~~~~~~~~~~~

.. |IsSorted| replace:: ``is_sorted``
.. _IsSorted: ./StdIsSorted.html

- ``exespace``, ``teamHandle``, ``first``, ``last``, ``view``, ``comp``: same as in |IsSorted|_
- ``exespace``, ``teamHandle``, ``first``, ``last``, ``view``, ``comp``: same as in :doc:`is_sorted <./StdIsSorted>`

- ``label``: string forwarded to internal parallel kernels for debugging purposes

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -92,11 +92,7 @@ Overload set accepting a team handle
Parameters and Requirements
~~~~~~~~~~~~~~~~~~~~~~~~~~~

.. _min_element_link: ./StdMinElement.html

.. |min_element_link| replace:: ``min_element``

- ``exespace``, ``first``, ``last``, ``view``, ``comp``: same as in |min_element_link|_
- ``exespace``, ``first``, ``last``, ``view``, ``comp``: same as in :doc:`min_element <./StdMinElement>`

- ``teamHandle``: team handle instance given inside a parallel region when using a TeamPolicy

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -92,11 +92,7 @@ Overload set accepting a team handle
Parameters and Requirements
~~~~~~~~~~~~~~~~~~~~~~~~~~~

.. _min_element_link: ./StdMinElement.html

.. |min_element_link| replace:: ``min_element``

- ``exespace``, ``first``, ``last``, ``view``, ``comp``: same as in |min_element_link|_
- ``exespace``, ``first``, ``last``, ``view``, ``comp``: same as in :doc:`min_element <./StdMinElement>`

- ``teamHandle``: team handle instance given inside a parallel region when using a TeamPolicy

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -93,10 +93,7 @@ Overload set accepting a team handle
Parameters and Requirements
~~~~~~~~~~~~~~~~~~~~~~~~~~~

.. |RemoveCopy| replace:: ``remove_copy``
.. _RemoveCopy: ./StdRemoveCopy.html

- ``exespace``, ``teamHandle``, ``first_from, last_from``, ``first_to``, ``view_from``, ``view_dest``: same as in |RemoveCopy|_
- ``exespace``, ``teamHandle``, ``first_from, last_from``, ``first_to``, ``view_from``, ``view_dest``: same as in :doc:`remove_copy <./StdRemoveCopy>`

- ``label``: string forwarded to internal parallel kernels for debugging purposes

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -71,10 +71,7 @@ Overload set accepting a team handle
Parameters and Requirements
~~~~~~~~~~~~~~~~~~~~~~~~~~~

.. |remove| replace:: ``remove``
.. _remove: ./StdRemove.html

- ``exespace``, ``first``, ``last``, ``view``: same as in |remove|_
- ``exespace``, ``first``, ``last``, ``view``: same as in :doc:`remove <./StdRemove>`

- ``teamHandle``: team handle instance given inside a parallel region when using a TeamPolicy

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -63,10 +63,7 @@ Overload set accepting a team handle
Parameters and Requirements
~~~~~~~~~~~~~~~~~~~~~~~~~~~

.. |ShiftLeft| replace:: ``shift_left``
.. _ShiftLeft: ./StdShiftLeft.html

- ``exespace`` ``teamHandle``, ``first``, ``last``, ``view``: same as in |ShiftLeft|_
- ``exespace`` ``teamHandle``, ``first``, ``last``, ``view``: same as in :doc:`shift_left <./StdShiftLeft>`

- ``label``: string forwarded to internal parallel kernels for debugging purposes

Expand Down
20 changes: 10 additions & 10 deletions docs/source/API/containers-index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,25 +7,25 @@ Containers API

* - Container
- Description
* - `Bitset <containers/Bitset.html>`__
* - :doc:`Bitset <containers/Bitset>`
- A concurrent Bitset class.
* - `DualView <containers/DualView.html>`__
* - :doc:`DualView <containers/DualView>`
- Container to manage access to mirrored views in different memory spaces.
* - `DynamicView <containers/DynamicView.html>`__
* - :doc:`DynamicView <containers/DynamicView>`
- DynamicView comment.
* - `DynRankView <containers/DynRankView.html>`__
* - :doc:`DynRankView <containers/DynRankView>`
- Kokkos Runtime-determined-dimension DynRankView class.
* - `ErrorReporter <containers/ErrorReporter.html>`__
* - :doc:`ErrorReporter <containers/ErrorReporter>`
- A class to facilitate thread-safe error output.
* - `OffsetView <containers/Offset-View.html>`__
* - :doc:`OffsetView <containers/Offset-View>`
- OffsetView comment.
* - `ScatterView <containers/ScatterView.html>`__
* - :doc:`ScatterView <containers/ScatterView>`
- ScatterView comment.
* - `StaticCrsGraph <containers/StaticCrsGraph.html>`__
* - :doc:`StaticCrsGraph <containers/StaticCrsGraph>`
- [DEPRECATED] StaticCrsGraph compressed raw storage graph
* - `UnorderedMap <containers/Unordered-Map.html>`__
* - :doc:`UnorderedMap <containers/Unordered-Map>`
- UnorderedMap comment.
* - `vector <containers/vector.html>`__
* - :doc:`vector <containers/vector>`
- [DEPRECATED] std::vector compatible implementation that works with non-host memory spaces.

.. toctree::
Expand Down
4 changes: 2 additions & 2 deletions docs/source/API/containers/DualView.rst
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ Users are responsible for updating the modified flags manually if they change th
Users may also synchronize data by calling the ``sync()`` method, which is templated on the device that requires synchronization (i.e., the target of the one-way copy operation).

The DualView class also provides convenience methods such as realloc, resize and capacity
which call the appropriate methods of the underlying `Kokkos::View <../core/view/view.html>`_ objects.
which call the appropriate methods of the underlying :doc:`Kokkos::View <../core/view/view>` objects.

The four template arguments are the same as those of ``Kokkos::View``.

Expand All @@ -27,7 +27,7 @@ The four template arguments are the same as those of ``Kokkos::View``.
and one in host memory. Otherwise, DualView will only store one View.

* MemoryTraits (optional) The user's intended memory access behavior. Please see the documentation
of `Kokkos::View <../core/view/view.html>`_ for examples. The default suffices for most users.
of :doc:`Kokkos::View <../core/view/view>` for examples. The default suffices for most users.

Usage
-----
Expand Down
13 changes: 2 additions & 11 deletions docs/source/API/containers/ScatterView.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,15 +10,6 @@ Header File: ``<Kokkos_ScatterView.hpp>``

``ScatterView`` is still in the namespace ``Kokkos::Experimental``


.. _parallelReduce: ../core/parallel-dispatch/parallel_reduce.html

.. |parallelReduce| replace:: :cpp:func:`parallel_reduce`

.. _View: ../core/view/view.html

.. |View| replace:: ``View``

.. |reset| replace:: ``reset()``

.. |access| replace:: ``access()``
Expand All @@ -30,7 +21,7 @@ Header File: ``<Kokkos_ScatterView.hpp>``
Usage
-----

A Kokkos ScatterView serves as an interface for a standard Kokkos::|View|_ implementing a scatter-add pattern either via atomics or data replication.
A Kokkos ScatterView serves as an interface for a standard Kokkos:::cpp:class:`View` implementing a scatter-add pattern either via atomics or data replication.
Copy link

Copilot AI Mar 23, 2026

Choose a reason for hiding this comment

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

There is a malformed inline C++ domain reference here (Kokkos:::cpp:class:...). This will render incorrectly and may prevent Sphinx from resolving the reference. Update it to either plain Kokkos::View or a valid role like :cpp:class:Kokkos::View.

Suggested change
A Kokkos ScatterView serves as an interface for a standard Kokkos:::cpp:class:`View` implementing a scatter-add pattern either via atomics or data replication.
A Kokkos ScatterView serves as an interface for a standard ``Kokkos::View`` implementing a scatter-add pattern either via atomics or data replication.

Copilot uses AI. Check for mistakes.

Construction of a ScatterView can be expensive, so you should try to reuse the same one if possible, in which case, you should call |reset|_ between uses.

Expand Down Expand Up @@ -181,7 +172,7 @@ Description
.. cpp:function:: contribute(View<DT1, VP...>& dest, Kokkos::Experimental::ScatterView<DT2, LY, ES, OP, CT, DP> const& src)

convenience function to perform final reduction of ScatterView
results into a resultant View; may be called following |parallelReduce|_.
results into a resultant View; may be called following :cpp:func:`Kokkos::parallel_reduce`.


Example
Expand Down
34 changes: 17 additions & 17 deletions docs/source/API/core-index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,40 +7,40 @@ Core API

* - Reducer
- Description
* - `Initialization and Finalization <core/Initialize-and-Finalize.html>`__
* - :doc:`Initialization and Finalization <core/Initialize-and-Finalize>`
- Initialization and finalization of Kokkos.
* - `View and related <core/View.html>`__
* - :doc:`View and related <core/View>`
- Kokkos MultiDimensional View class and related free functions.
* - `Parallel Execution/Dispatch <core/ParallelDispatch.html>`__
* - :doc:`Parallel Execution/Dispatch <core/ParallelDispatch>`
- Parallel Execution Dispatch.
* - `Built-in Reducers <core/builtin_reducers.html>`__
* - :doc:`Built-in Reducers <core/builtin_reducers>`
- Built-in Reducers
* - `Execution Policies <core/Execution-Policies.html>`__
* - :doc:`Execution Policies <core/Execution-Policies>`
- Execution policies.
* - `Spaces <core/Spaces.html>`__
* - :doc:`Spaces <core/Spaces>`
- Description of Memory and Execution Spaces.
* - `Task-Parallelism <core/Task-Parallelism.html>`__
* - :doc:`Task-Parallelism <core/Task-Parallelism>`
- Creating and dispatching Task Graphs.
* - `MultiGPU Support <core/MultiGPUSupport.html>`__
* - :doc:`MultiGPU Support <core/MultiGPUSupport>`
- Launching kernels on multiple GPUs from one process.
* - `Atomics <core/atomics.html>`__
* - :doc:`Atomics <core/atomics>`
- Atomics
* - `Numerics <core/Numerics.html>`__
* - :doc:`Numerics <core/Numerics>`
- Common mathematical functions, mathematical constants, numeric traits,
complex numbers, half-precision floating-point types.
* - `C-style memory management <core/c_style_memory_management.html>`__
* - :doc:`C-style memory management <core/c_style_memory_management>`
- C-style memory management
* - `Traits <core/Prod.html>`__
* - :doc:`Traits <core/Traits>`
- Traits
* - `Kokkos Concepts <core/KokkosConcepts.html>`__
* - :doc:`Kokkos Concepts <core/KokkosConcepts>`
- Kokkos Concepts
* - `STL Compatibility Issues <core/STL-Compatibility.html>`__
* - :doc:`STL Compatibility Issues <core/STL-Compatibility>`
- Ports of standard C++ capabilities, which otherwise do not work on various hardware platforms.
* - `Utilities <core/Utilities.html>`__
* - :doc:`Utilities <core/Utilities>`
- Utility functionality part of Kokkos Core.
* - `Detection Idiom <core/Detection-Idiom.html>`__
* - :doc:`Detection Idiom <core/Detection-Idiom>`
- Used to recognize, in an SFINAE-friendly way, the validity of any C++ expression.
* - `Macros <core/Macros.html>`__
* - :doc:`Macros <core/Macros>`
- Global macros defined by Kokkos, used for architectures, general settings, etc.

.. toctree::
Expand Down
26 changes: 14 additions & 12 deletions docs/source/API/core/Execution-Policies.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ Execution Policies
Top Level Execution Policies
============================

`ExecutionPolicyConcept <policies/ExecutionPolicyConcept.html>`__ is the fundamental abstraction to represent “how” the execution of a Kokkos parallel pattern takes place.
:doc:`ExecutionPolicyConcept <policies/ExecutionPolicyConcept>` is the fundamental abstraction to represent “how” the execution of a Kokkos parallel pattern takes place.

.. list-table::
:widths: 35 65
Expand All @@ -14,19 +14,19 @@ Top Level Execution Policies
* - Policy
- Description

* * `RangePolicy <policies/RangePolicy.html>`__
* * :doc:`RangePolicy <policies/RangePolicy>`
* Each iterate is an integer in a contiguous range

* * `MDRangePolicy <policies/MDRangePolicy.html>`_
* * :doc:`MDRangePolicy <policies/MDRangePolicy>`
* Each iterate for each rank is an integer in a contiguous range

* * `TeamPolicy <policies/TeamPolicy.html>`__
* * :doc:`TeamPolicy <policies/TeamPolicy>`
* Assigns to each iterate in a contiguous range a team of threads

Nested Execution Policies
============================

Nested Execution Policies are used to dispatch parallel work inside of an already executing parallel region either dispatched with a `TeamPolicy <policies/TeamPolicy.html>`__ or a task policy. `NestedPolicies <policies/NestedPolicies.html>`__ summary.
Nested Execution Policies are used to dispatch parallel work inside of an already executing parallel region either dispatched with a :doc:`TeamPolicy <policies/TeamPolicy>` or a task policy. :doc:`NestedPolicies <policies/NestedPolicies>` summary.

.. list-table::
:widths: 25 75
Expand All @@ -36,24 +36,26 @@ Nested Execution Policies are used to dispatch parallel work inside of an alread
* - Policy
- Description

* * `TeamThreadMDRange <policies/TeamThreadMDRange.html>`__
* * :doc:`TeamThreadMDRange <policies/TeamThreadMDRange>`
* Used inside of a TeamPolicy kernel to perform nested parallel loops over a multidimensional range split over threads of a team.

* * `TeamThreadRange <policies/TeamThreadRange.html>`__
* * :doc:`TeamThreadRange <policies/TeamThreadRange>`
* Used inside of a TeamPolicy kernel to perform nested parallel loops split over threads of a team.

* * `TeamVectorMDRange <policies/TeamVectorMDRange.html>`__
* * :doc:`TeamVectorMDRange <policies/TeamVectorMDRange>`
* Used inside of a TeamPolicy kernel to perform nested parallel loops over a multidimensional range split over threads of a team and their vector lanes.

* * `TeamVectorRange <policies/TeamVectorRange.html>`__
* * :doc:`TeamVectorRange <policies/TeamVectorRange>`
* Used inside of a TeamPolicy kernel to perform nested parallel loops split over threads of a team and their vector lanes.

* * `ThreadVectorMDRange <policies/ThreadVectorMDRange.html>`__
* * :doc:`ThreadVectorMDRange <policies/ThreadVectorMDRange>`
* Used inside of a TeamPolicy kernel to perform nested parallel loops over a multidimensional range with vector lanes of a thread.

* * `ThreadVectorRange <policies/ThreadVectorRange.html>`__
* * :doc:`ThreadVectorRange <policies/ThreadVectorRange>`
* Used inside of a TeamPolicy kernel to perform nested parallel loops with vector lanes of a thread.

.. _kokkos-common-arguments-for-all-execution-policies:

Common Arguments for all Execution Policies
===========================================

Expand Down Expand Up @@ -82,7 +84,7 @@ Execution Policies generally accept compile time arguments via template paramete

* * IndexType
* e.g. ``IndexType<int>``
* Specify integer type to be used for traversing the iteration space. Defaults to the ``size_type`` of `ExecutionSpaceConcept <execution_spaces.html#typedefs>`__. Can affect the performance depending on the backend.
* Specify integer type to be used for traversing the iteration space. Defaults to the ``size_type`` of :doc:`ExecutionSpaceConcept <execution_spaces>`. Can affect the performance depending on the backend.

* * LaunchBounds
* ``LaunchBounds<MaxThreads, MinBlocks>``
Expand Down
Loading
Loading