Add new docs

rapidsai · Dec 1, 2023 · b3f714e · b3f714e
1 parent a461b3e
commit b3f714e
Show file tree

Hide file tree

Showing 4 changed files with 31 additions and 1 deletion.
diff --git a/docs/api.rst b/docs/api.rst
@@ -65,7 +65,35 @@ Cython
 ******
 
 The `rapids_cython` functions allow projects to easily build cython modules using
+`scikit-build-core <https://scikit-build-core.readthedocs.io/en/latest/>`_.
+Users of the `legacy Cython functions <cython_legacy_>`_ should be able to change
+``include(rapids-cython)`` to ``include(rapids-cython-core)`` and have their build
+continue to work otherwise unchanged when switching from scikit-build to scikit-build-core.
+
+.. note::
+  Use of the rapids-cython-core component of rapids-cmake requires
+  scikit-build-core. The behavior of the functions provided by this component
+  is undefined if they are invoked outside of a build managed by
+  scikit-build-core.
+
+.. toctree::
+   :titlesonly:
+
+   /command/rapids_cython_init
+   /command/rapids_cython_create_modules
+   /command/rapids_cython_add_rpath_entries
+
+
+.. _`cython_legacy`:
+
+Cython (Legacy)
+***************
+
+The legacy `rapids_cython` functions allow projects to easily build cython modules using
 `scikit-build <https://scikit-build.readthedocs.io/en/latest/>`_.
+These functions are deprecated in favor of the functions in `rapids-cython-core`, which are
+designed to be nearly drop-in replacements for `rapids-cython` for use with the newer
+`scikit-build-core <https://scikit-build-core.readthedocs.io/en/latest/>`_ package.
 
 .. note::
   Use of the rapids-cython component of rapids-cmake requires scikit-build. The behavior of the functions provided by
@@ -78,7 +106,6 @@ The `rapids_cython` functions allow projects to easily build cython modules usin
    /command/rapids_cython_create_modules
    /command/rapids_cython_add_rpath_entries
 
-
 .. _`find`:
 
 Find

diff --git a/docs/command/rapids_cython_core_add_rpath_entries.rst b/docs/command/rapids_cython_core_add_rpath_entries.rst
@@ -0,0 +1 @@
+.. cmake-module:: ../../rapids-cmake/cython-core/add_rpath_entries.cmake
diff --git a/docs/command/rapids_cython_core_create_modules.rst b/docs/command/rapids_cython_core_create_modules.rst
@@ -0,0 +1 @@
+.. cmake-module:: ../../rapids-cmake/cython-core/create_modules.cmake
diff --git a/docs/command/rapids_cython_core_init.rst b/docs/command/rapids_cython_core_init.rst
@@ -0,0 +1 @@
+.. cmake-module:: ../../rapids-cmake/cython-core/init.cmake