Adding ATTENTION banner or cuVS in rst_prolog

rapidsai · Mar 13, 2024 · 8ae5691 · 8ae5691
1 parent f5ef451
commit 8ae5691
Show file tree

Hide file tree

Showing 6 changed files with 11 additions and 25 deletions.
diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -1,4 +1,4 @@
-# Copyright (c) 2018-2023, NVIDIA CORPORATION.
+# Copyright (c) 2018-2024, NVIDIA CORPORATION.
 
 import os
 import sys
@@ -36,6 +36,8 @@
     "sphinx_copybutton"
 ]
 
+
+
 breathe_default_project = "RAFT"
 breathe_projects = {
     "RAFT": "../../cpp/doxygen/_xml/",
@@ -62,6 +64,14 @@
 copyright = "2023, NVIDIA Corporation"
 author = "NVIDIA Corporation"
 
+rst_prolog = """
+
+.. attention::
+
+  The vector search and clustering algorithms in RAFT are being migrated to a new library dedicated to vector search called `cuVS <https://github.com/rapidsai/cuvs>`_. We will continue to support the vector search algorithms in RAFT during this move, will no longer update them after the RAPIDS 24.06 (June) release. We plan to complete the migration by RAPIDS 24.08 (August) release.
+
+"""
+
 # The version info for the project you're documenting, acts as replacement for
 # |version| and |release|, also used in various other places throughout the
 # built documents.

diff --git a/docs/source/cpp_api/cluster.rst b/docs/source/cpp_api/cluster.rst
@@ -4,11 +4,6 @@ Cluster
 This page provides C++ API references for the publicly-exposed elements of the `raft/cluster` headers. RAFT provides
 fundamental clustering algorithms which are, themselves, considered reusable building blocks for other algorithms.
 
-.. note::
-
-  The vector search and clustering algorithms in RAFT are being migrated to a new library dedicated to vector search called `cuVS <https://github.com/rapidsai/cuvs>`_. We will continue to support the vector search algorithms in RAFT during this move, will no longer update them after the RAPIDS 24.06 (June) release. We plan to complete the migration by RAPIDS 24.08 (August) release.
-
-
 .. role:: py(code)
    :language: c++
    :class: highlight

diff --git a/docs/source/cpp_api/neighbors.rst b/docs/source/cpp_api/neighbors.rst
@@ -3,11 +3,6 @@ Neighbors
 
 This page provides C++ class references for the publicly-exposed elements of the neighbors package.
 
-.. note::
-
-  The vector search and clustering algorithms in RAFT are being migrated to a new library dedicated to vector search called `cuVS <https://github.com/rapidsai/cuvs>`_. We will continue to support the vector search algorithms in RAFT during this move, will no longer update them after the RAPIDS 24.06 (June) release. We plan to complete the migration by RAPIDS 24.08 (August) release.
-
-
 .. role:: py(code)
    :language: c++
    :class: highlight

diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -1,10 +1,6 @@
 RAPIDS RAFT: Reusable Accelerated Functions and Tools for Vector Search and More
 ================================================================================
 
-.. note::
-
-  The vector search and clustering algorithms in RAFT are being migrated to a new library dedicated to vector search called `cuVS <https://github.com/rapidsai/cuvs>`_. We will continue to support the vector search algorithms in RAFT during this move, will no longer update them after the RAPIDS 24.06 (June) release. We plan to complete the migration by RAPIDS 24.08 (August) release.
-
 .. image:: ../../img/raft-tech-stack-vss.png
   :width: 800
   :alt: RAFT Tech Stack

diff --git a/docs/source/pylibraft_api/cluster.rst b/docs/source/pylibraft_api/cluster.rst
@@ -3,11 +3,6 @@ Cluster
 
 This page provides pylibraft class references for the publicly-exposed elements of the `pylibraft.cluster` package.
 
-.. note::
-
-  The vector search and clustering algorithms in RAFT are being migrated to a new library dedicated to vector search called `cuVS <https://github.com/rapidsai/cuvs>`_. We will continue to support the vector search algorithms in RAFT during this move, will no longer update them after the RAPIDS 24.06 (June) release. We plan to complete the migration by RAPIDS 24.08 (August) release.
-
-
 .. role:: py(code)
    :language: python
    :class: highlight

diff --git a/docs/source/pylibraft_api/neighbors.rst b/docs/source/pylibraft_api/neighbors.rst
@@ -3,11 +3,6 @@ Neighbors
 
 This page provides pylibraft class references for the publicly-exposed elements of the neighbors package.
 
-.. note::
-
-  The vector search and clustering algorithms in RAFT are being migrated to a new library dedicated to vector search called `cuVS <https://github.com/rapidsai/cuvs>`_. We will continue to support the vector search algorithms in RAFT during this move, will no longer update them after the RAPIDS 24.06 (June) release. We plan to complete the migration by RAPIDS 24.08 (August) release.
-
-
 .. role:: py(code)
    :language: python
    :class: highlight