link np

docs/api_reference.rst

@@ -11,14 +11,14 @@ FFT Plan
 --------
 
 .. list-table::
-   :widths: 25 25 50
+   :widths: 50 25 25
    :header-rows: 1
 
-   * - 
+   * - Description
      - ``KokkosFFT``
      - ``numpy.fft``
-   * - 
-     - :doc:`KokkosFFT::Impl::Plan<api/plan>`
+   * - A class that manages a FFT plan of backend FFT library
+     - :doc:`api/plan`
      - 
 
 Standard FFTs
@@ -34,6 +34,32 @@ Standard FFTs
    api/standard/fftn.rst
    api/standard/ifftn.rst
 
+.. list-table::
+   :widths: 50 25 25
+   :header-rows: 1
+
+   * - Description
+     - ``KokkosFFT``
+     - ``numpy.fft``
+   * - One dimensional FFT in forward direction
+     - :doc:`api/standard/fft`
+     - `numpy.fft.fft <https://numpy.org/doc/stable/reference/generated/numpy.fft.fft.html>`_
+   * - One dimensional FFT in backward direction
+     - :doc:`api/standard/ifft`
+     - `numpy.fft.ifft <https://numpy.org/doc/stable/reference/generated/numpy.fft.ifft.html>`_ 
+   * - Two dimensional FFT in forward direction
+     - :doc:`api/standard/fft2`
+     - `numpy.fft.fft2 <https://numpy.org/doc/stable/reference/generated/numpy.fft.fft2.html>`_ 
+   * - Two dimensional FFT in backward direction
+     - :doc:`api/standard/ifft2`
+     - `numpy.fft.ifft2 <https://numpy.org/doc/stable/reference/generated/numpy.fft.ifft2.html>`_ 
+   * - N-dimensional FFT in forward direction
+     - :doc:`api/standard/fftn`
+     - `numpy.fft.fftn <https://numpy.org/doc/stable/reference/generated/numpy.fft.fftn.html>`_ 
+   * - N-dimensional FFT in backward direction
+     - :doc:`api/standard/ifftn`
+     - `numpy.fft.ifftn <https://numpy.org/doc/stable/reference/generated/numpy.fft.ifftn.html>`_ 
+
 Real FFTs
 ---------
 

docs/intro/building.rst

@@ -83,19 +83,19 @@ However, to enable this option, we need a pre-installed ``fftw`` for FFT on host
    * - 
      - Description
      - Default
-   * - KokkosFFT_ENABLE_HOST_AND_DEVICE
+   * - ``KokkosFFT_ENABLE_HOST_AND_DEVICE``
      - Enable FFT on both host and device.
      - OFF
-   * - KokkosFFT_INTERNAL_Kokkos
+   * - ``KokkosFFT_INTERNAL_Kokkos``
      - Build internal Kokkos instead of relying on external one.
      - OFF
-   * - KokkosFFT_ENABLE_EXAMPLES
+   * - ``KokkosFFT_ENABLE_EXAMPLES``
      - Build KokkosFFT examples
      - ON
-   * - KokkosFFT_ENABLE_TESTS
+   * - ``KokkosFFT_ENABLE_TESTS``
      - Build KokkosFFT tests
      - OFF
-   * - KokkosFFT_ENABLE_BENCHMARK
+   * - ``KokkosFFT_ENABLE_BENCHMARK``
      - Build benchmarks for KokkosFFT
      - OFF
 
@@ -107,7 +107,7 @@ A FFT library dedicated to Kokkos Device backend (e.g. cufft for CUDA backend) i
 If CMake fails to find a backend FFT library, see :doc:`How to find fft libraries?<../finding_libraries>`.
 We may support experimental backends like ``OPENMPTARGET`` in the future.
 
-.. list-table:: Host backend
+.. list-table:: ``Host backend``
    :widths: 25 25 25 25
    :header-rows: 1
 
@@ -128,7 +128,7 @@ We may support experimental backends like ``OPENMPTARGET`` in the future.
      - ``fftw (OpenMP)``
      - OFF
 
-.. list-table:: Device backend
+.. list-table:: ``Device backend``
    :widths: 25 25 25 25
    :header-rows: 1