Replace custom API doc extractors with numpydoc and Doxygen

Python API: keep AST walking (no imports needed) but pipe docstrings
through numpydoc.docscrape.NumpyDocString, giving properly structured
Parameters / Returns / Raises / Examples sections in the generated MDX.

C API: replace fragile regex header parser with Doxygen XML pipeline.
Doxyfile targets the two public headers; XML is parsed with ElementTree
and rendered to MDX. Picks up 211 symbols vs ~80 before, handles @PARAM,
@return, @brief, and enum values correctly.

Add numpydoc to requirements-docs.txt and dependencies.yaml docs group.
Add doxygen to dependencies.yaml docs group.
Gitignore cpp/build_split/ and fern/.doxygen-xml/ build directories.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

Author: ramakrishnap-nv

.gitignore

@@ -45,6 +45,7 @@ datasets/**
 ## Doxygen
 cpp/doxygen/html
 cpp/doxygen/xml
+fern/.doxygen-xml/
 
 # Jupyter Notebooks
 .ipynb_checkpoints
@@ -80,3 +81,4 @@ cpp/include/cuopt/semantic_version.hpp
 
 # conda env (recommended name)
 .cuopt_env
+cpp/build_split/

dependencies.yaml

@@ -789,7 +789,9 @@ dependencies:
           - jq
           - nodejs        # provides npm; used to install fern-api CLI
           - *pyyaml
+          - *doxygen
           - fastapi
+          - numpydoc
           - pydantic
 
   notebooks:

fern/Doxyfile

@@ -0,0 +1,41 @@
+# Doxyfile for fern/extract_c_api.py
+# Processes the two cuOpt C API headers and outputs XML only.
+# Run from the repo root: doxygen fern/Doxyfile
+# XML is written to fern/.doxygen-xml/ (git-ignored).
+
+DOXYFILE_ENCODING      = UTF-8
+PROJECT_NAME           = "cuOpt C API"
+PROJECT_BRIEF          = "NVIDIA cuOpt C API reference"
+OUTPUT_DIRECTORY       = fern/.doxygen-xml
+CREATE_SUBDIRS         = NO
+OUTPUT_LANGUAGE        = English
+FULL_PATH_NAMES        = NO
+MARKDOWN_SUPPORT       = YES
+EXTENSION_MAPPING      = h=C
+OPTIMIZE_OUTPUT_FOR_C  = YES
+
+EXTRACT_ALL            = YES
+EXTRACT_PRIVATE        = NO
+EXTRACT_STATIC         = NO
+
+INPUT                  = cpp/include/cuopt/mathematical_optimization/cuopt_c.h \
+                         cpp/include/cuopt/mathematical_optimization/constants.h
+
+INPUT_ENCODING         = UTF-8
+FILE_PATTERNS          = *.h
+RECURSIVE              = NO
+
+ENABLE_PREPROCESSING   = YES
+MACRO_EXPANSION        = YES
+EXPAND_ONLY_PREDEF     = NO
+SKIP_FUNCTION_MACROS   = YES
+
+GENERATE_HTML          = NO
+GENERATE_LATEX         = NO
+GENERATE_XML           = YES
+XML_OUTPUT             = xml
+XML_PROGRAMLISTING     = NO
+
+QUIET                  = YES
+WARNINGS               = YES
+WARN_IF_UNDOCUMENTED   = NO

fern/docs/pages/cuopt-c/convex/convex-c-api.mdx

@@ -12,9 +12,9 @@ For MIP problems, one or more primal solution hints (MIP starts) may be provided
 
 <hr />
 
-#### `cuOptAddMIPStart(cuOptSolverSettings settings, const cuopt_float_t* solution, cuopt_int_t num_variables) -> cuopt_int_t`
+#### `cuOptAddMIPStart(cuOptSolverSettings settings, const cuopt_float_t * solution, cuopt_int_t num_variables) -> cuopt_int_t`
 
-Add an initial solution (MIP start) for MIP solving.  This function can be called multiple times to add multiple MIP starts. The solver will use these as starting points for the MIP search.
+Add an initial solution (MIP start) for MIP solving.
 
 <Note>
 Currently unsupported with presolve on. All pointer arguments (solution) refer to host memory.
@@ -23,7 +23,7 @@ Currently unsupported with presolve on. All pointer arguments (solution) refer t
 **Parameters**
 
 - **`settings`** (`cuOptSolverSettings`) `[in]` — The solver settings object.
-- **`solution`** (`const cuopt_float_t*`) `[in]` — A pointer to an array of type cuopt_float_t of size num_variables containing the solution values.
+- **`solution`** (`const cuopt_float_t *`) `[in]` — A pointer to an array of type cuopt_float_t of size num_variables containing the solution values.
 - **`num_variables`** (`cuopt_int_t`) `[in]` — The number of variables (size of the solution array).
 
 **Returns** A status code indicating success or failure.
@@ -64,7 +64,7 @@ All pointer arguments (solution, objective_value, solution_bound, user_data) ref
 
 <hr />
 
-#### `cuOptSetMIPGetSolutionCallback(cuOptSolverSettings settings, cuOptMIPGetSolutionCallback callback, void* user_data) -> cuopt_int_t`
+#### `cuOptSetMIPGetSolutionCallback(cuOptSolverSettings settings, cuOptMIPGetSolutionCallback callback, void * user_data) -> cuopt_int_t`
 
 Register a callback to receive incumbent MIP solutions.
 
@@ -76,13 +76,13 @@ The callback arguments refer to host memory and are only valid during the callba
 
 - **`settings`** (`cuOptSolverSettings`) `[in]` — The solver settings object.
 - **`callback`** (`cuOptMIPGetSolutionCallback`) `[in]` — Callback function to receive incumbent solutions.
-- **`user_data`** (`void*`) `[in]` — User-defined pointer passed through to the callback. It will be forwarded to `cuOptMIPGetSolutionCallback` when invoked.
+- **`user_data`** (`void *`) `[in]` — User-defined pointer passed through to the callback. It will be forwarded to `cuOptMIPGetSolutionCallback` when invoked.
 
 **Returns** A status code indicating success or failure.
 
 <hr />
 
-#### `cuOptSetMIPSetSolutionCallback(cuOptSolverSettings settings, cuOptMIPSetSolutionCallback callback, void* user_data) -> cuopt_int_t`
+#### `cuOptSetMIPSetSolutionCallback(cuOptSolverSettings settings, cuOptMIPSetSolutionCallback callback, void * user_data) -> cuopt_int_t`
 
 Register a callback to inject MIP solutions.
 
@@ -94,7 +94,7 @@ Registering a set-solution callback disables presolve. The callback arguments re
 
 - **`settings`** (`cuOptSolverSettings`) `[in]` — The solver settings object.
 - **`callback`** (`cuOptMIPSetSolutionCallback`) `[in]` — Callback function to inject solutions.
-- **`user_data`** (`void*`) `[in]` — User-defined pointer passed through to the callback. It will be forwarded to `cuOptMIPSetSolutionCallback` when invoked.
+- **`user_data`** (`void *`) `[in]` — User-defined pointer passed through to the callback. It will be forwarded to `cuOptMIPSetSolutionCallback` when invoked.
 
 **Returns** A status code indicating success or failure.