[DRAFT] Convert docs from sphink -> fern

.github/workflows/check-c-abi.yaml

@@ -127,5 +127,5 @@ jobs:
                    - The changes are documented in the changelog
                    - Migration guide is provided for users
 
-                For more information, see the [C ABI documentation](../docs/source/c_developer_guide.md).`
+                For more information, see the [developer guide](../fern/pages/developer_guide.md).`
             });

CHANGELOG.md

@@ -576,7 +576,7 @@
 - Vendor RAPIDS.cmake ([#816](https://github.com/rapidsai/cuvs/pull/816)) [@bdice](https://github.com/bdice)
 - Update libcuvs libraft ver to 25.06 in conda env ([#808](https://github.com/rapidsai/cuvs/pull/808)) [@jinsolp](https://github.com/jinsolp)
 - Moving NN Descent class and struct declarations to `nn_descent_gnnd.hpp` ([#803](https://github.com/rapidsai/cuvs/pull/803)) [@jinsolp](https://github.com/jinsolp)
-- Remove `[@rapidsai/cuvs-build-codeowners` ([#783](https://github.com/rapidsai/cuvs/pull/783)) @KyleFromNVIDIA](https://github.com/rapidsai/cuvs-build-codeowners` ([#783](https://github.com/rapidsai/cuvs/pull/783)) @KyleFromNVIDIA)
+- Remove @rapidsai/cuvs-build-codeowners ([#783](https://github.com/rapidsai/cuvs/pull/783)) [@KyleFromNVIDIA](https://github.com/KyleFromNVIDIA)
 - Moving wheel builds to specified location and uploading build artifacts to Github ([#777](https://github.com/rapidsai/cuvs/pull/777)) [@VenkateshJaya](https://github.com/VenkateshJaya)
 - Remove unused raft cagra header in add_nodes.cuh ([#741](https://github.com/rapidsai/cuvs/pull/741)) [@jiangyinzuo](https://github.com/jiangyinzuo)
 - Expose kmeans to python ([#729](https://github.com/rapidsai/cuvs/pull/729)) [@benfred](https://github.com/benfred)

README.md

@@ -206,7 +206,7 @@ For more code examples of the Rust APIs, including a drop-in project templates,
 
 ## Contributing
 
-If you are interested in contributing to the cuVS library, please read our [Contributing guidelines](docs/source/contributing.md). Refer to the [Developer Guide](docs/source/developer_guide.md) for details on the developer guidelines, workflows, and principles.
+If you are interested in contributing to the cuVS library, please read our [Contributing guidelines](fern/pages/contributing.md). Refer to the [Developer Guide](fern/pages/developer_guide.md) for details on the developer guidelines, workflows, and principles.
 
 ## References
 

build.sh

@@ -29,7 +29,7 @@ HELP="$0 [<target> ...] [<flag> ...] [--cmake-args=\"<args>\"] [--cache-tool=<to
    rust             - build the cuvs Rust bindings
    go               - build the cuvs Go bindings
    java             - build the cuvs Java bindings
-   docs             - build the documentation
+   docs             - run the Fern documentation build script
    tests            - build the tests
    bench-ann        - build end-to-end ann benchmarks
    examples         - build the examples
@@ -62,13 +62,14 @@ HELP="$0 [<target> ...] [<flag> ...] [--cmake-args=\"<args>\"] [--cache-tool=<to
                                  to speedup the build process.
    --time                      - Enable nvcc compilation time logging into cpp/build/nvcc_compile_log.csv.
                                  Results can be interpreted with cpp/scripts/analyze_nvcc_log.py
+   FERN_DOCS_MODE=<mode>       - mode passed to fern/build_docs.sh for the docs target
+                                 (check, preview, publish, or dev; defaults to check)
    -h                          - print this text
 
  default action (no args) is to build libcuvs, tests and cuvs targets
 "
 LIBCUVS_BUILD_DIR=${LIBCUVS_BUILD_DIR:=${REPODIR}/cpp/build}
-SPHINX_BUILD_DIR=${REPODIR}/docs
-DOXYGEN_BUILD_DIR=${REPODIR}/cpp/doxygen
+FERN_DOCS_DIR=${REPODIR}/fern
 PYTHON_BUILD_DIR=${REPODIR}/python/cuvs/_skbuild
 RUST_BUILD_DIR=${REPODIR}/rust/target
 JAVA_BUILD_DIR=${REPODIR}/java/cuvs-java/target
@@ -371,7 +372,7 @@ fi
 
 ################################################################################
 # Configure for building all C++ targets
-if (( NUMARGS == 0 )) || hasArg libcuvs || hasArg docs || hasArg tests || hasArg bench-prims || hasArg bench-ann || hasArg examples; then
+if (( NUMARGS == 0 )) || hasArg libcuvs || hasArg tests || hasArg bench-prims || hasArg bench-ann || hasArg examples; then
     COMPILE_LIBRARY=ON
     if [[ "${BUILD_SHARED_LIBS}" != "OFF" ]]; then
         CMAKE_TARGET+=("cuvs")
@@ -535,13 +536,7 @@ export RAPIDS_VERSION_MAJOR_MINOR
 
 if hasArg docs; then
     set -x
-    cd "${DOXYGEN_BUILD_DIR}"
-    doxygen Doxyfile
-    cd "${SPHINX_BUILD_DIR}"
-    make html
-    cd "${REPODIR}"/rust
-    cargo doc -p cuvs --no-deps
-    rsync -av "${RUST_BUILD_DIR}"/doc/ "${SPHINX_BUILD_DIR}"/build/html/_static/rust
+    "${FERN_DOCS_DIR}/build_docs.sh" "${FERN_DOCS_MODE:-check}"
 fi
 
 ################################################################################

ci/build_docs.sh

@@ -4,25 +4,16 @@
 
 set -euo pipefail
 
-rapids-logger "Downloading artifacts from previous jobs"
-CPP_CHANNEL=$(rapids-download-conda-from-github cpp)
-PYTHON_CHANNEL=$(rapids-download-from-github "$(rapids-package-name "conda_python" cuvs --stable --cuda "$RAPIDS_CUDA_VERSION")")
-
 rapids-logger "Create test conda environment"
 . /opt/conda/etc/profile.d/conda.sh
 
 rapids-logger "Configuring conda strict channel priority"
 conda config --set channel_priority strict
 
-RAPIDS_VERSION_MAJOR_MINOR="$(rapids-version-major-minor)"
-export RAPIDS_VERSION_MAJOR_MINOR
-
 rapids-dependency-file-generator \
   --output conda \
   --file-key docs \
   --matrix "cuda=${RAPIDS_CUDA_VERSION%.*};arch=$(arch);py=${RAPIDS_PY_VERSION}" \
-  --prepend-channel "${CPP_CHANNEL}" \
-  --prepend-channel "${PYTHON_CHANNEL}" \
   | tee env.yaml
 
 rapids-mamba-retry env create --yes -f env.yaml -n docs
@@ -35,27 +26,8 @@ set -eu
 
 rapids-print-env
 
-RAPIDS_DOCS_DIR="$(mktemp -d)"
-export RAPIDS_DOCS_DIR
-
-rapids-logger "Build CPP docs"
-pushd cpp/doxygen
-doxygen Doxyfile
-popd
-
-rapids-logger "Build Rust docs"
-pushd rust
-LIBCLANG_PATH=$(dirname "$(find "$CONDA_PREFIX" -name libclang.so | head -n 1)")
-export LIBCLANG_PATH
-cargo doc -p cuvs --no-deps
-popd
-
-rapids-logger "Build Python docs"
-pushd docs
-make dirhtml
-mv ../rust/target/doc ./build/dirhtml/_static/rust
-mkdir -p "${RAPIDS_DOCS_DIR}/cuvs/"html
-mv build/dirhtml/* "${RAPIDS_DOCS_DIR}/cuvs/html"
-popd
-
-RAPIDS_VERSION_NUMBER="${RAPIDS_VERSION_MAJOR_MINOR}" rapids-upload-docs
+rapids-logger "Install Fern CLI"
+npm install -g fern-api
+
+rapids-logger "Validate Fern docs"
+fern/build_docs.sh check

ci/release/update-version.sh

@@ -139,14 +139,14 @@ if [[ "${RUN_CONTEXT}" == "main" ]]; then
   :
 elif [[ "${RUN_CONTEXT}" == "release" ]]; then
   # In release context, use release branch for documentation links (word boundaries to avoid partial matches)
-  sed_runner "/rapidsai\\/cuvs/ s|\\bmain\\b|release/${NEXT_SHORT_TAG}|g" docs/source/developer_guide.md
+  sed_runner "/rapidsai\\/cuvs/ s|\\bmain\\b|release/${NEXT_SHORT_TAG}|g" fern/pages/developer_guide.md
   sed_runner "s|\\bmain\\b|release/${NEXT_SHORT_TAG}|g" README.md
   # Only update the GitHub URL, not the main() function
   sed_runner "s|/cuvs/blob/\\bmain\\b/|/cuvs/blob/release/${NEXT_SHORT_TAG}/|g" python/cuvs_bench/cuvs_bench/plot/__main__.py
 fi
 
 # Update cuvs-bench Docker image references (version-only, not branch-related)
-sed_runner "s|rapidsai/cuvs-bench:[0-9][0-9].[0-9][0-9]|rapidsai/cuvs-bench:${NEXT_SHORT_TAG}|g" docs/source/cuvs_bench/index.rst
+sed_runner "s|rapidsai/cuvs-bench:[0-9][0-9].[0-9][0-9]|rapidsai/cuvs-bench:${NEXT_SHORT_TAG}|g" fern/pages/cuvs_bench/index.md
 
 # Version references (not branch-related)
 sed_runner "s|=[0-9][0-9].[0-9][0-9]|=${NEXT_SHORT_TAG}|g" README.md

conda/environments/all_cuda-129_arch-aarch64.yaml

@@ -6,7 +6,6 @@ channels:
 - conda-forge
 dependencies:
 - _go_select *=cgo
-- breathe>=4.35.0
 - c-compiler
 - clang-tools==20.1.8
 - clang==20.1.8
@@ -21,11 +20,8 @@ dependencies:
 - cxx-compiler
 - cython>=3.2.2
 - dlpack>=0.8,<1.0
-- doxygen>=1.8.20
 - gcc_linux-aarch64=14.*
 - go
-- graphviz
-- ipython
 - libclang==20.1.8
 - libcublas-dev
 - libcurand-dev
@@ -37,22 +33,16 @@ dependencies:
 - make
 - nccl>=2.19
 - ninja
+- nodejs>=18
 - numpy>=1.23,<3.0
-- numpydoc
 - openblas
 - pre-commit
 - pylibraft==26.6.*,>=0.0.0a0
 - pytest
 - pytest-cov
 - rapids-build-backend>=0.4.0,<0.5.0
-- recommonmark
 - rust
 - scikit-build-core>=0.11.0
 - scikit-learn>=1.5
-- sphinx-copybutton
-- sphinx-markdown-tables
-- sphinx>=8.0.0
 - sysroot_linux-aarch64==2.28
-- pip:
-  - nvidia-sphinx-theme
 name: all_cuda-129_arch-aarch64

conda/environments/all_cuda-129_arch-x86_64.yaml

@@ -6,7 +6,6 @@ channels:
 - conda-forge
 dependencies:
 - _go_select *=cgo
-- breathe>=4.35.0
 - c-compiler
 - clang-tools==20.1.8
 - clang==20.1.8
@@ -21,11 +20,8 @@ dependencies:
 - cxx-compiler
 - cython>=3.2.2
 - dlpack>=0.8,<1.0
-- doxygen>=1.8.20
 - gcc_linux-64=14.*
 - go
-- graphviz
-- ipython
 - libclang==20.1.8
 - libcublas-dev
 - libcurand-dev
@@ -36,22 +32,16 @@ dependencies:
 - make
 - nccl>=2.19
 - ninja
+- nodejs>=18
 - numpy>=1.23,<3.0
-- numpydoc
 - openblas
 - pre-commit
 - pylibraft==26.6.*,>=0.0.0a0
 - pytest
 - pytest-cov
 - rapids-build-backend>=0.4.0,<0.5.0
-- recommonmark
 - rust
 - scikit-build-core>=0.11.0
 - scikit-learn>=1.5
-- sphinx-copybutton
-- sphinx-markdown-tables
-- sphinx>=8.0.0
 - sysroot_linux-64==2.28
-- pip:
-  - nvidia-sphinx-theme
 name: all_cuda-129_arch-x86_64

conda/environments/all_cuda-131_arch-aarch64.yaml

@@ -6,7 +6,6 @@ channels:
 - conda-forge
 dependencies:
 - _go_select *=cgo
-- breathe>=4.35.0
 - c-compiler
 - clang-tools==20.1.8
 - clang==20.1.8
@@ -21,11 +20,8 @@ dependencies:
 - cxx-compiler
 - cython>=3.2.2
 - dlpack>=0.8,<1.0
-- doxygen>=1.8.20
 - gcc_linux-aarch64=14.*
 - go
-- graphviz
-- ipython
 - libclang==20.1.8
 - libcublas-dev
 - libcurand-dev
@@ -37,22 +33,16 @@ dependencies:
 - make
 - nccl>=2.19
 - ninja
+- nodejs>=18
 - numpy>=1.23,<3.0
-- numpydoc
 - openblas
 - pre-commit
 - pylibraft==26.6.*,>=0.0.0a0
 - pytest
 - pytest-cov
 - rapids-build-backend>=0.4.0,<0.5.0
-- recommonmark
 - rust
 - scikit-build-core>=0.11.0
 - scikit-learn>=1.5
-- sphinx-copybutton
-- sphinx-markdown-tables
-- sphinx>=8.0.0
 - sysroot_linux-aarch64==2.28
-- pip:
-  - nvidia-sphinx-theme
 name: all_cuda-131_arch-aarch64

conda/environments/all_cuda-131_arch-x86_64.yaml

@@ -6,7 +6,6 @@ channels:
 - conda-forge
 dependencies:
 - _go_select *=cgo
-- breathe>=4.35.0
 - c-compiler
 - clang-tools==20.1.8
 - clang==20.1.8
@@ -21,11 +20,8 @@ dependencies:
 - cxx-compiler
 - cython>=3.2.2
 - dlpack>=0.8,<1.0
-- doxygen>=1.8.20
 - gcc_linux-64=14.*
 - go
-- graphviz
-- ipython
 - libclang==20.1.8
 - libcublas-dev
 - libcurand-dev
@@ -36,22 +32,16 @@ dependencies:
 - make
 - nccl>=2.19
 - ninja
+- nodejs>=18
 - numpy>=1.23,<3.0
-- numpydoc
 - openblas
 - pre-commit
 - pylibraft==26.6.*,>=0.0.0a0
 - pytest
 - pytest-cov
 - rapids-build-backend>=0.4.0,<0.5.0
-- recommonmark
 - rust
 - scikit-build-core>=0.11.0
 - scikit-learn>=1.5
-- sphinx-copybutton
-- sphinx-markdown-tables
-- sphinx>=8.0.0
 - sysroot_linux-64==2.28
-- pip:
-  - nvidia-sphinx-theme
 name: all_cuda-131_arch-x86_64

dependencies.yaml

@@ -446,17 +446,7 @@ dependencies:
     common:
       - output_types: [conda]
         packages:
-          - breathe>=4.35.0
-          - doxygen>=1.8.20
-          - graphviz
-          - ipython
-          - numpydoc
-          - recommonmark
-          - sphinx>=8.0.0
-          - sphinx-copybutton
-          - sphinx-markdown-tables
-          - pip:
-              - nvidia-sphinx-theme
+          - nodejs>=18
   rust:
     common:
       - output_types: [conda]