Skip to content
Open
Show file tree
Hide file tree
Changes from 1 commit
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/ -n -W --keep-going
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Is that going to run as part of the CI?
How expensive is it? Should that be just part of the html rule?

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

seems like we currently don't. But I am for doing it if it is cheap

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

It only checks external links, and there are a lot of false positives.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

do we know how to reduce the false positives?

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

I've just left it there so that developers can use it easily. I don't think it can be included in a CI

do we know how to reduce the false positives?

need to add the :doc: tag to some links

2 changes: 1 addition & 1 deletion docs/source/API/core-index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ Core API
complex numbers, half-precision floating-point types.
* - `C-style memory management <core/c_style_memory_management.html>`__
- C-style memory management
* - `Traits <core/Prod.html>`__
* - `Traits <core/Traits.html>`__
- Traits
* - `Kokkos Concepts <core/KokkosConcepts.html>`__
- Kokkos Concepts
Expand Down
8 changes: 8 additions & 0 deletions docs/source/API/core/Execution-Policies.rst
Original file line number Diff line number Diff line change
Expand Up @@ -92,6 +92,14 @@ Execution Policies generally accept compile time arguments via template paramete
* ``SomeClass``
* Specify the work tag type used to call the functor operator. Can be any arbitrary tag type (i.e. an [empty](https://en.cppreference.com/w/cpp/types/is_empty) struct or class). Defaults to ``void``.

Experimental Execution Policy Arguments
---------------------------------------

.. cpp:struct:: template <unsigned int BatchSize = 1> StaticBatchSize;

Specify a batch size for unrolling loops at compile time. Have effect only effect `RangePolicy <policies/RangePolicy.html>`__ for ``CUDA`` and ``HIP`` backends.

.. versionadded:: 5.0

.. toctree::
:hidden:
Expand Down
2 changes: 1 addition & 1 deletion docs/source/API/core/numerics/mathematical-functions.rst
Original file line number Diff line number Diff line change
Expand Up @@ -417,7 +417,7 @@ Floating point manipulation functions

.. |scalbn| replace:: ``scalbn``

.. _scalbln: https://en.cppreference.com/w/cpp/numeric/math/scalbln
.. _scalbln: https://en.cppreference.com/w/cpp/numeric/math/scalbn

.. |scalbln| replace:: ``scalbln``
Comment on lines +420 to 422
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.

The external reference target for scalbln points to the scalbn cppreference page. This makes the link incorrect. Update the URL to the correct cppreference page for scalbln.

Copilot uses AI. Check for mistakes.

Expand Down
4 changes: 3 additions & 1 deletion docs/source/get-started/requirements.rst
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
.. include:: ../mydefs.rst

Comment thread
JBludau marked this conversation as resolved.
Requirements
############

Expand Down Expand Up @@ -177,7 +179,7 @@ Build system:
=============

* CMake >= 3.16: required
* CMake >= 3.18: Fortran linkage. This does not affect most mixed Fortran/Kokkos builds. See `known build issues <https://github.com/kokkos/kokkos/blob/master/BUILD.md#known-issues>`_.
* CMake >= 3.18: Fortran linkage. This does not affect most mixed Fortran/Kokkos builds. See `known build issues <https://github.com/kokkos/kokkos/issues/3325>`_.
Comment thread
Adrien-Tab marked this conversation as resolved.
Outdated
* CMake >= 3.21.1 for NVC++

Primary tested compiler are passing in release mode
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ the clang-format style specified in the repository.

Test configurations are defined in the `kokkos/.jenkins`, and `kokkos/.github/workflows/*` files and determine the official
primary software stack support.
The tested compiler versions are also listed [here](https://kokkos.github.io/kokkos-core-wiki/requirements.html).
The tested compiler versions are also listed [here](../get-started/requirements).
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.

This Markdown link points to ../get-started/requirements without an extension or Sphinx cross-reference. In the built HTML this is likely to be a broken relative URL (it won't automatically resolve to requirements.html). Prefer a MyST/Sphinx doc link (e.g., {doc}/:doc:) to get-started/requirements so Sphinx can resolve it and linkcheck can validate it.

Copilot uses AI. Check for mistakes.
These test configurations (sparsely) cover the cross product of hardware platforms (e.g. NVIDIA. Intel, and AMD),
compilers (e.g. GCC, Clang, NVC++), C++ standards (17-23), Kokkos backends (e.g. Cuda, OpenMP, and HIP) and Kokkos
configuration options (e.g. Debug, Relocatable Device Code).
Expand Down
3 changes: 1 addition & 2 deletions docs/source/usecases/MDRangePolicy.md
Original file line number Diff line number Diff line change
Expand Up @@ -137,5 +137,4 @@ The API reference for the [`MDRangePolicy`](../API/core/policies/MDRangePolicy)
The use case that this example is based on comes from the Intrepid2 package of Trilinos. For more examples, check out code in Trilinos in files at: `Trilinos/packages/intrepid2/src/Shared/Intrepid2_ArrayToolsDef*.hpp`.

This link provides some overview of the Intrepid package:
[documentation link](https://trilinos.org/packages/intrepid/)

[documentation link](https://trilinos.github.io/docs/intrepid2/index.html)
Loading