Treat warnings as errors in doc builds + MG ANNs Python API doc update

build.sh

@@ -517,10 +517,10 @@ if hasArg docs; then
     cd "${DOXYGEN_BUILD_DIR}"
     doxygen Doxyfile
     cd "${SPHINX_BUILD_DIR}"
-    sphinx-build -W -b html source _html
+    make html
     cd "${REPODIR}"/rust
     cargo doc -p cuvs --no-deps
-    rsync -av "${RUST_BUILD_DIR}"/doc/ "${SPHINX_BUILD_DIR}"/_html/_static/rust
+    rsync -av "${RUST_BUILD_DIR}"/doc/ "${SPHINX_BUILD_DIR}"/build/html/_static/rust
 fi
 
 ################################################################################

ci/build_docs.sh

@@ -1,5 +1,5 @@
 #!/bin/bash
-# Copyright (c) 2023-2024, NVIDIA CORPORATION.
+# Copyright (c) 2023-2025, NVIDIA CORPORATION.
 
 set -euo pipefail
 
@@ -48,10 +48,10 @@ popd
 
 rapids-logger "Build Python docs"
 pushd docs
-sphinx-build -b dirhtml source _html
-mv ../rust/target/doc ./_html/_static/rust
+make dirhtml
+mv ../rust/target/doc ./build/dirhtml/_static/rust
 mkdir -p "${RAPIDS_DOCS_DIR}/cuvs/"html
-mv _html/* "${RAPIDS_DOCS_DIR}/cuvs/html"
+mv build/dirhtml/* "${RAPIDS_DOCS_DIR}/cuvs/html"
 popd
 
 RAPIDS_VERSION_NUMBER="${RAPIDS_VERSION_MAJOR_MINOR}" rapids-upload-docs

cpp/include/cuvs/neighbors/cagra.hpp

@@ -1964,6 +1964,10 @@ void serialize_to_hnswlib(
   std::optional<raft::host_matrix_view<const uint8_t, int64_t, raft::row_major>> dataset =
     std::nullopt);
 
+/**
+ * @}
+ */
+
 /**
  * @defgroup cagra_cpp_index_merge CAGRA index build functions
  * @{

cpp/include/cuvs/neighbors/hnsw.hpp

@@ -163,6 +163,10 @@ struct extend_params {
   int num_threads = 0;
 };
 
+/**
+ * @}
+ */
+
 /**
  * @defgroup hnsw_cpp_index_load Load CAGRA index as hnswlib index
  * @{

cpp/include/cuvs/neighbors/vamana.hpp

@@ -488,6 +488,10 @@ auto build(raft::resources const& res,
            raft::host_matrix_view<const uint8_t, int64_t, raft::row_major> dataset)
   -> cuvs::neighbors::vamana::index<uint8_t, uint32_t>;
 
+/**
+ * @}
+ */
+
 /**
  * @defgroup vamana_cpp_serialize Vamana serialize functions
  * @{

cpp/include/cuvs/preprocessing/spectral_embedding.hpp

@@ -23,11 +23,6 @@
 
 namespace cuvs::preprocessing::spectral_embedding {
 
-/**
- * @defgroup spectral_embedding Spectral Embedding
- * @{
- */
-
 /**
  * @brief Parameters for spectral embedding algorithm
  *
@@ -71,6 +66,11 @@ struct params {
   uint64_t seed;
 };
 
+/**
+ * @defgroup spectral_embedding Spectral Embedding
+ * @{
+ */
+
 /**
  * @brief Perform spectral embedding on input dataset
  *

docs/Makefile

@@ -2,7 +2,7 @@
 #
 
 # You can set these variables from the command line.
-SPHINXOPTS    =
+SPHINXOPTS    = -W
 SPHINXBUILD   = sphinx-build
 SPHINXPROJ    = cuvs
 SOURCEDIR     = source

docs/source/neighbors/all_neighbors.rst

@@ -16,7 +16,7 @@ All-neighbors supports multiple underlying algorithms:
 
 The algorithm partitions the dataset into clusters and distributes the work across multiple GPUs when possible, making it suitable for large-scale graph construction tasks.
 
-[ :doc:`C API <../c_api/neighbors_all_neighbors_c>` |:doc:`C++ API <../cpp_api/neighbors_all_neighbors>` | :doc:`Python API <../python_api/neighbors_all_neighbors>` ]
+[ :doc:`C API <../c_api/neighbors_all_neighbors_c>` | :doc:`C++ API <../cpp_api/neighbors_all_neighbors>` | :doc:`Python API <../python_api/neighbors_all_neighbors>` ]
 
 Algorithm Overview
 ------------------

docs/source/python_api/neighbors_mg_cagra.rst

@@ -14,42 +14,42 @@ Multi-GPU CAGRA extends the graph-based CAGRA algorithm to work across multiple
 Index build parameters
 ######################
 
-.. autoclass:: cuvs.neighbors.mg_cagra.IndexParams
+.. autoclass:: cuvs.neighbors.mg.cagra.IndexParams
     :members:
 
 Index search parameters
 #######################
 
-.. autoclass:: cuvs.neighbors.mg_cagra.SearchParams
+.. autoclass:: cuvs.neighbors.mg.cagra.SearchParams
     :members:
 
 Index
 #####
 
-.. autoclass:: cuvs.neighbors.mg_cagra.Index
+.. autoclass:: cuvs.neighbors.mg.cagra.Index
     :members:
 
 Index build
 ###########
 
-.. autofunction:: cuvs.neighbors.mg_cagra.build
+.. autofunction:: cuvs.neighbors.mg.cagra.build
 
 Index search
 ############
 
-.. autofunction:: cuvs.neighbors.mg_cagra.search
+.. autofunction:: cuvs.neighbors.mg.cagra.search
 
 Index save
 ##########
 
-.. autofunction:: cuvs.neighbors.mg_cagra.save
+.. autofunction:: cuvs.neighbors.mg.cagra.save
 
 Index load
 ##########
 
-.. autofunction:: cuvs.neighbors.mg_cagra.load
+.. autofunction:: cuvs.neighbors.mg.cagra.load
 
 Index distribute
 ################
 
-.. autofunction:: cuvs.neighbors.mg_cagra.distribute
+.. autofunction:: cuvs.neighbors.mg.cagra.distribute

docs/source/python_api/neighbors_mg_ivf_flat.rst

@@ -14,47 +14,47 @@ Multi-GPU IVF-Flat extends the IVF-Flat algorithm to work across multiple GPUs,
 Index build parameters
 ######################
 
-.. autoclass:: cuvs.neighbors.mg_ivf_flat.IndexParams
+.. autoclass:: cuvs.neighbors.mg.ivf_flat.IndexParams
     :members:
 
 Index search parameters
 #######################
 
-.. autoclass:: cuvs.neighbors.mg_ivf_flat.SearchParams
+.. autoclass:: cuvs.neighbors.mg.ivf_flat.SearchParams
     :members:
 
 Index
 #####
 
-.. autoclass:: cuvs.neighbors.mg_ivf_flat.Index
+.. autoclass:: cuvs.neighbors.mg.ivf_flat.Index
     :members:
 
 Index build
 ###########
 
-.. autofunction:: cuvs.neighbors.mg_ivf_flat.build
+.. autofunction:: cuvs.neighbors.mg.ivf_flat.build
 
 Index search
 ############
 
-.. autofunction:: cuvs.neighbors.mg_ivf_flat.search
+.. autofunction:: cuvs.neighbors.mg.ivf_flat.search
 
 Index extend
 ############
 
-.. autofunction:: cuvs.neighbors.mg_ivf_flat.extend
+.. autofunction:: cuvs.neighbors.mg.ivf_flat.extend
 
 Index save
 ##########
 
-.. autofunction:: cuvs.neighbors.mg_ivf_flat.save
+.. autofunction:: cuvs.neighbors.mg.ivf_flat.save
 
 Index load
 ##########
 
-.. autofunction:: cuvs.neighbors.mg_ivf_flat.load
+.. autofunction:: cuvs.neighbors.mg.ivf_flat.load
 
 Index distribute
 ################
 
-.. autofunction:: cuvs.neighbors.mg_ivf_flat.distribute
+.. autofunction:: cuvs.neighbors.mg.ivf_flat.distribute

docs/source/python_api/neighbors_mg_ivf_pq.rst

@@ -14,47 +14,47 @@ Multi-GPU IVF-PQ extends the IVF-PQ (Inverted File with Product Quantization) al
 Index build parameters
 ######################
 
-.. autoclass:: cuvs.neighbors.mg_ivf_pq.IndexParams
+.. autoclass:: cuvs.neighbors.mg.ivf_pq.IndexParams
     :members:
 
 Index search parameters
 #######################
 
-.. autoclass:: cuvs.neighbors.mg_ivf_pq.SearchParams
+.. autoclass:: cuvs.neighbors.mg.ivf_pq.SearchParams
     :members:
 
 Index
 #####
 
-.. autoclass:: cuvs.neighbors.mg_ivf_pq.Index
+.. autoclass:: cuvs.neighbors.mg.ivf_pq.Index
     :members:
 
 Index build
 ###########
 
-.. autofunction:: cuvs.neighbors.mg_ivf_pq.build
+.. autofunction:: cuvs.neighbors.mg.ivf_pq.build
 
 Index search
 ############
 
-.. autofunction:: cuvs.neighbors.mg_ivf_pq.search
+.. autofunction:: cuvs.neighbors.mg.ivf_pq.search
 
 Index extend
 ############
 
-.. autofunction:: cuvs.neighbors.mg_ivf_pq.extend
+.. autofunction:: cuvs.neighbors.mg.ivf_pq.extend
 
 Index save
 ##########
 
-.. autofunction:: cuvs.neighbors.mg_ivf_pq.save
+.. autofunction:: cuvs.neighbors.mg.ivf_pq.save
 
 Index load
 ##########
 
-.. autofunction:: cuvs.neighbors.mg_ivf_pq.load
+.. autofunction:: cuvs.neighbors.mg.ivf_pq.load
 
 Index distribute
 ################
 
-.. autofunction:: cuvs.neighbors.mg_ivf_pq.distribute
+.. autofunction:: cuvs.neighbors.mg.ivf_pq.distribute