add targets

kokkos · Feb 17, 2024 · 2576b12 · 2576b12
1 parent ad907f6
commit 2576b12
Show file tree

Hide file tree

Showing 9 changed files with 12 additions and 3 deletions.
diff --git a/docs/examples.rst b/docs/examples.rst
@@ -1,3 +1,4 @@
+.. _examples:
 
 Examples
 ========

diff --git a/docs/intro/building.rst b/docs/intro/building.rst
@@ -75,6 +75,7 @@ For FFTs on Kokkos device only, we do not need to add extra compile options but
 In order to use KokkosFFT from both host and device, we need to add ``KokkosFFT_ENABLE_HOST_AND_DEVICE=ON``.
 This option may be useful, for example FFT is used for initialization at host. 
 However, to enable this option, we need a pre-installed ``fftw`` for FFT on host, so it is disabled in default.
+(see :doc:`minimum working example<../samples/05_1DFFT_HOST_DEVICE>`)
 
 .. list-table:: CMake options
    :widths: 25 25 50
@@ -86,7 +87,7 @@ However, to enable this option, we need a pre-installed ``fftw`` for FFT on host
    * - ``KokkosFFT_ENABLE_HOST_AND_DEVICE``
      - Enable FFT on both host and device.
      - OFF
-   * - ``KokkosFFT_INTERNAL_Kokkos``
+   * - ``KokkosFFT_ENABLE_INTERNAL_KOKKOS``
      - Build internal Kokkos instead of relying on external one.
      - OFF
    * - ``KokkosFFT_ENABLE_EXAMPLES``

diff --git a/docs/intro/using.rst b/docs/intro/using.rst
@@ -59,8 +59,8 @@ The following listing shows good and bad examples of Real FFTs.
 
    We have to use the same precision (either ``float`` or ``double``) for input and ouptut Views.
 
-Supported Views
----------------
+Supported data types
+--------------------
 
 Firstly, the input and output Views must have the same LayoutType and rank.
 For the moment, we accept Kokkos Views with some restriction in data types and Layout.
@@ -106,6 +106,7 @@ Reuse FFT plan
 Apart from the basic APIs, KokkosFFT APIs include overloaded APIs which can take a FFT plan as an argument.
 Using these overloaded APIs, we can reuse the FFT plan created before. 
 In some backend, FFT plan creation leads to some overhead, wherein we need this functionality.
+(see :doc:`minimum working example<../samples/06_1DFFT_reuse_plans>`)
 
 .. note::
 

diff --git a/docs/samples/01_1DFFT.rst b/docs/samples/01_1DFFT.rst
@@ -1,3 +1,4 @@
+.. _01_1DFFT:
 
 One dimensional FFT
 -------------------

diff --git a/docs/samples/02_2DFFT.rst b/docs/samples/02_2DFFT.rst
@@ -1,3 +1,4 @@
+.. _02_2DFFT:
 
 Two dimensional FFT
 -------------------

diff --git a/docs/samples/03_NDFFT.rst b/docs/samples/03_NDFFT.rst
@@ -1,3 +1,4 @@
+.. _03_NDFFT:
 
 N-dimensional FFT
 -----------------

diff --git a/docs/samples/04_batchedFFT.rst b/docs/samples/04_batchedFFT.rst
@@ -1,3 +1,4 @@
+.. _04_batchedFFT:
 
 One-dimensional batched FFT
 ---------------------------

diff --git a/docs/samples/05_1DFFT_HOST_DEVICE.rst b/docs/samples/05_1DFFT_HOST_DEVICE.rst
@@ -1,3 +1,4 @@
+.. _05_1DFFT_HOST_DEVICE:
 
 FFT on host and device
 ----------------------

diff --git a/docs/samples/06_1DFFT_reuse_plans.rst b/docs/samples/06_1DFFT_reuse_plans.rst
@@ -1,3 +1,4 @@
+.. _06_1DFFT_reuse_plans:
 
 Reuse fft plan
 --------------