Updating docs and build script

.gitignore

@@ -95,5 +95,6 @@ python/cugraph/cugraph/tests/dask-worker-space
 
 # Sphinx docs & build artifacts
 docs/cugraph/source/api_docs/api/*
+docs/cugraph/libcugraph
 _html
 _text

build.sh

@@ -22,12 +22,14 @@ REPODIR=$(cd $(dirname $0); pwd)
 VALIDARGS="
    clean
    uninstall
+   all
    libcugraph
    libcugraph_etl
-   cugraph
-   cugraph-service
    pylibcugraph
+   cugraph
    cpp-mgtests
+   cugraph-service
+   cugraph-nx
    cugraph-pyg
    cugraph-dgl
    nx-cugraph
@@ -49,14 +51,15 @@ HELP="$0 [<target> ...] [<flag> ...]
  where <target> is:
    clean                      - remove all existing build artifacts and configuration (start over)
    uninstall                  - uninstall libcugraph and cugraph from a prior build/install (see also -n)
+   all                        - build every target
    libcugraph                 - build libcugraph.so and SG test binaries
    libcugraph_etl             - build libcugraph_etl.so and SG test binaries
    pylibcugraph               - build the pylibcugraph Python package
-   cugraph-pyg                - build the cugraph-pyg Python package
    cugraph                    - build the cugraph Python package
-   nx-cugraph                 - build the nx-cugraph Python package
-   cugraph-service            - build the cugraph-service_client and cugraph-service_server Python package
    cpp-mgtests                - build libcugraph and libcugraph_etl MG tests. Builds MPI communicator, adding MPI as a dependency.
+   cugraph-service            - build the cugraph-service_client and cugraph-service_server Python package
+   nx-cugraph                 - build the nx-cugraph Python package
+   cugraph-pyg                - build the cugraph-pyg Python package
    cugraph-dgl                - build the cugraph-dgl extensions for DGL
    docs                       - build the docs
  and <flag> is:
@@ -71,7 +74,7 @@ HELP="$0 [<target> ...] [<flag> ...]
    --clean                    - clean an individual target (note: to do a complete rebuild, use the clean target described above)
    -h                         - print this text
 
- default action (no args) is to build and install 'libcugraph' then 'libcugraph_etl' then 'pylibcugraph' then 'cugraph' targets
+ default action (no args) is to build and install 'libcugraph' then 'pylibcugraph' then 'cugraph' targets
 
  libcugraph build dir is: ${LIBCUGRAPH_BUILD_DIR}
 
@@ -119,8 +122,8 @@ function hasArg {
     (( ${NUMARGS} != 0 )) && (echo " ${ARGS} " | grep -q " $1 ")
 }
 
-function buildAll {
-    (( ${NUMARGS} == 0 )) || !(echo " ${ARGS} " | grep -q " [^-][a-zA-Z0-9\_\-]\+ ")
+function noTargets {
+    (( ${NUMARGS} == 0 )) || !(echo " ${ARGS} " | grep -q " [^-][a-zA-Z0-9\_\-]* ")
 }
 
 function cleanPythonDir {
@@ -170,7 +173,7 @@ fi
 if hasArg --without_cugraphops; then
     BUILD_WITH_CUGRAPHOPS=OFF
 fi
-if hasArg cpp-mgtests; then
+if hasArg cpp-mgtests || hasArg all; then
     BUILD_CPP_MG_TESTS=ON
 fi
 if hasArg --cmake_default_generator; then
@@ -234,13 +237,23 @@ if hasArg clean; then
             rmdir ${bd} || true
         fi
     done
+
+    # Doc cleanup
+    rm -rf ${REPODIR}/docs/cugraph/libcugraph
+    rm -rf ${REPODIR}/docs/cugraph/build
+
     # Go back to failing on first error for all other operations
     set -e
 fi
 
+################################################################################
+# Process in the order that things should be built
+################################################################################
+
+
 ################################################################################
 # Configure, build, and install libcugraph
-if buildAll || hasArg libcugraph; then
+if hasArg libcugraph || hasArg all || noTargets; then
     if hasArg --clean; then
         if [ -d ${LIBCUGRAPH_BUILD_DIR} ]; then
             find ${LIBCUGRAPH_BUILD_DIR} -mindepth 1 -delete
@@ -270,7 +283,7 @@ if buildAll || hasArg libcugraph; then
 fi
 
 # Configure, build, and install libcugraph_etl
-if buildAll || hasArg libcugraph_etl; then
+if hasArg libcugraph_etl || hasArg all; then
     if hasArg --clean; then
         if [ -d ${LIBCUGRAPH_ETL_BUILD_DIR} ]; then
             find ${LIBCUGRAPH_ETL_BUILD_DIR} -mindepth 1 -delete
@@ -301,7 +314,7 @@ if buildAll || hasArg libcugraph_etl; then
 fi
 
 # Build, and install pylibcugraph
-if buildAll || hasArg pylibcugraph; then
+if hasArg pylibcugraph || hasArg all || noTargets; then
     if hasArg --clean; then
         cleanPythonDir ${REPODIR}/python/pylibcugraph
     else
@@ -328,7 +341,7 @@ if buildAll || hasArg pylibcugraph; then
 fi
 
 # Build and install the cugraph Python package
-if buildAll || hasArg cugraph; then
+if hasArg cugraph || hasArg all || noTargets; then
     if hasArg --clean; then
         cleanPythonDir ${REPODIR}/python/cugraph
     else
@@ -355,7 +368,7 @@ if buildAll || hasArg cugraph; then
 fi
 
 # Install the cugraph-service-client and cugraph-service-server Python packages
-if hasArg cugraph-service; then
+if hasArg all || hasArg cugraph-service; then
     if hasArg --clean; then
         cleanPythonDir ${REPODIR}/python/cugraph-service
     else
@@ -364,8 +377,17 @@ if hasArg cugraph-service; then
     fi
 fi
 
+# Build and install the cugraph-nx Python package
+if hasArg all || hasArg nx-cugraph; then
+    if hasArg --clean; then
+        cleanPythonDir ${REPODIR}/python/nx-cugraph
+    else
+        python ${PYTHON_ARGS_FOR_INSTALL} ${REPODIR}/python/nx-cugraph
+    fi
+fi
+
 # Build and install the cugraph-pyg Python package
-if hasArg cugraph-pyg; then
+if hasArg all || hasArg cugraph-pyg; then
     if hasArg --clean; then
         cleanPythonDir ${REPODIR}/python/cugraph-pyg
     else
@@ -374,25 +396,18 @@ if hasArg cugraph-pyg; then
 fi
 
 # Install the cugraph-dgl extensions for DGL
-if hasArg cugraph-dgl; then
+if hasArg all || hasArg cugraph-dgl; then
     if hasArg --clean; then
         cleanPythonDir ${REPODIR}/python/cugraph-dgl
     else
         python ${PYTHON_ARGS_FOR_INSTALL} ${REPODIR}/python/cugraph-dgl
     fi
 fi
 
-# Build and install the nx-cugraph Python package
-if hasArg nx-cugraph; then
-    if hasArg --clean; then
-        cleanPythonDir ${REPODIR}/python/nx-cugraph
-    else
-        python ${PYTHON_ARGS_FOR_INSTALL} ${REPODIR}/python/nx-cugraph
-    fi
-fi
 
 # Build the docs
-if hasArg docs; then
+# - build the CPP docs first using doxygen, then create the Python docs
+if hasArg all || hasArg docs; then
     if [ ! -d ${LIBCUGRAPH_BUILD_DIR} ]; then
         mkdir -p ${LIBCUGRAPH_BUILD_DIR}
         cd ${LIBCUGRAPH_BUILD_DIR}
@@ -402,8 +417,20 @@ if hasArg docs; then
               ${CMAKE_GENERATOR_OPTION} \
               ${CMAKE_VERBOSE_OPTION}
     fi
+
     cd ${LIBCUGRAPH_BUILD_DIR}
     cmake --build "${LIBCUGRAPH_BUILD_DIR}" -j${PARALLEL_LEVEL} --target docs_cugraph ${VERBOSE_FLAG}
+
+    if [ -d ${REPODIR}/docs/cugraph/libcugraph ]; then
+        echo "removing libcugraph docs dir"
+        rm -r ${REPODIR}/docs/cugraph/libcugraph
+    fi
+    echo "making libcugraph doc dir"
+    mkdir -p ${REPODIR}/docs/cugraph/libcugraph
+
+    mv ${REPODIR}/cpp/doxygen/xml   ${REPODIR}/docs/cugraph/libcugraph/_xml
+    mv ${REPODIR}/cpp/doxygen/html  ${REPODIR}/docs/cugraph/libcugraph/html
+
     cd ${REPODIR}/docs/cugraph
     make html
 fi

ci/build_docs.sh

@@ -29,7 +29,8 @@ rapids-mamba-retry install \
   cugraph-pyg \
   cugraph-service-server \
   cugraph-service-client \
-  libcugraph_etl
+  libcugraph_etl \
+  pylibcugraphops
 
 # This command installs `cugraph-dgl` without its dependencies
 # since this package can currently only run in `11.6` CTK environments
@@ -45,15 +46,21 @@ pushd cpp/doxygen
 doxygen Doxyfile
 mkdir -p "${RAPIDS_DOCS_DIR}/libcugraph/html"
 mv html/* "${RAPIDS_DOCS_DIR}/libcugraph/html"
+mkdir -p "${RAPIDS_DOCS_DIR}/libcugraph/_xml"
+mv xml/* "${RAPIDS_DOCS_DIR}/libcugraph/_xml"
 popd
 
 rapids-logger "Build Python docs"
 pushd docs/cugraph
 # Ensure cugraph is importable, since sphinx does not report details about this
 # type of failure well.
 python -c "import cugraph; print(f'Using cugraph: {cugraph}')"
-sphinx-build -b dirhtml source _html
-sphinx-build -b text source _text
+echo "Running sphinx-build -v -b dirhtml source _html"
+sphinx-build -v -b dirhtml source _html
+echo "done."
+echo "Running sphinx-build -v -b text source _text"
+sphinx-build -v -b text source _text
+echo "done."
 mkdir -p "${RAPIDS_DOCS_DIR}/cugraph/"{html,txt}
 mv _html/* "${RAPIDS_DOCS_DIR}/cugraph/html"
 mv _text/* "${RAPIDS_DOCS_DIR}/cugraph/txt"

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

@@ -11,6 +11,7 @@ channels:
 - nvidia
 dependencies:
 - aiohttp
+- breathe
 - c-compiler
 - cmake>=3.26.4
 - cuda-version=11.8
@@ -70,6 +71,7 @@ dependencies:
 - sphinx-markdown-tables
 - sphinx<6
 - sphinxcontrib-websupport
+- thriftpy2>=0.4.15
 - ucx-proc=*=gpu
 - ucx-py==0.34.*
 name: all_cuda-118_arch-x86_64

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

@@ -11,6 +11,7 @@ channels:
 - nvidia
 dependencies:
 - aiohttp
+- breathe
 - c-compiler
 - cmake>=3.26.4
 - cuda-nvcc
@@ -69,6 +70,7 @@ dependencies:
 - sphinx-markdown-tables
 - sphinx<6
 - sphinxcontrib-websupport
+- thriftpy2>=0.4.15
 - ucx-proc=*=gpu
 - ucx-py==0.34.*
 name: all_cuda-120_arch-x86_64

cpp/CMakeLists.txt

@@ -412,7 +412,7 @@ add_library(cugraph_c
         src/c_api/core_result.cpp
         src/c_api/extract_ego.cpp
         src/c_api/k_core.cpp
-	src/c_api/hierarchical_clustering_result.cpp
+        src/c_api/hierarchical_clustering_result.cpp
         src/c_api/induced_subgraph.cpp
         src/c_api/capi_helper.cu
         src/c_api/legacy_spectral.cpp

cpp/doxygen/Doxyfile

@@ -1991,7 +1991,7 @@ MAN_LINKS              = NO
 # captures the structure of the code including all documentation.
 # The default value is: NO.
 
-GENERATE_XML           = NO
+GENERATE_XML           = YES
 
 # The XML_OUTPUT tag is used to specify where the XML pages will be put. If a
 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of