Align cuOpt documentation branding and Doxygen configuration (#1503)

- adds a GitHub icon to the NVIDIA Sphinx theme header
- removes the unused custom square NVIDIA logo
- uses `NVIDIA cuOpt Documentation` consistently for LaTeX, man, and Texinfo output
- removes obsolete or unavailable Doxygen 1.9.1 options and host-specific inputs
- corrects the documented termination-status parameter name
- removes redundant Breathe auto-Doxygen configuration

## Issue

Follow-up to rapidsai/build-planning#300.

## Validation

- Doxygen 1.9.1 generation completes without warnings
- strict Sphinx HTML build passes with `-n -W --keep-going`
- Sphinx link check passes
- targeted pre-commit hooks pass

Authors:
  - Bradley Dice (https://github.com/bdice)

Approvers:
  - Ramakrishna Prabhu (https://github.com/ramakrishnap-nv)
  - Alice Boucher (https://github.com/aliceb-nv)

URL: #1503

Author: bdice

cpp/doxygen/Doxyfile

@@ -234,7 +234,6 @@ ALIASES                =
 # A mapping has the form "name=value". For example adding "class=itcl::class"
 # will allow you to use the command class in the itcl::class meaning.
 
-TCL_SUBST              =
 
 # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources
 # only. Doxygen will then generate output that is more tailored for C. For
@@ -773,8 +772,7 @@ WARN_LOGFILE           =
 
 INPUT                  = main_page.md \
                          ../include/cuopt/mathematical_optimization/cuopt_c.h \
-                         ../include/cuopt/mathematical_optimization/constants.h \
-                         /usr/include/stdint.h
+                         ../include/cuopt/mathematical_optimization/constants.h
 
 # This tag can be used to specify the character encoding of the source files
 # that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses
@@ -1020,15 +1018,13 @@ VERBATIM_HEADERS       = YES
 # generated with the -Duse-libclang=ON option for CMake.
 # The default value is: NO.
 
-CLANG_ASSISTED_PARSING = NO
 
 # If clang assisted parsing is enabled you can provide the compiler with command
 # line options that you would normally use when invoking the compiler. Note that
 # the include paths will already be set by doxygen for the files and directories
 # specified with INPUT and INCLUDE_PATH.
 # This tag requires that the tag CLANG_ASSISTED_PARSING is set to YES.
 
-CLANG_OPTIONS          =
 
 #---------------------------------------------------------------------------
 # Configuration options related to the alphabetical class index
@@ -1046,7 +1042,6 @@ ALPHABETICAL_INDEX     = YES
 # Minimum value: 1, maximum value: 20, default value: 5.
 # This tag requires that the tag ALPHABETICAL_INDEX is set to YES.
 
-COLS_IN_ALPHA_INDEX    = 5
 
 # In case all classes in a project start with a common prefix, all classes will
 # be put under the same header in the alphabetical index. The IGNORE_PREFIX tag
@@ -2117,7 +2112,6 @@ EXTERNAL_PAGES         = YES
 # interpreter (i.e. the result of 'which perl').
 # The default file (with absolute path) is: /usr/bin/perl.
 
-PERL_PATH              = /usr/bin/perl
 
 #---------------------------------------------------------------------------
 # Configuration options related to the dot tool
@@ -2139,7 +2133,6 @@ CLASS_DIAGRAMS         = YES
 # the mscgen tool resides. If left empty the tool is assumed to be found in the
 # default search path.
 
-MSCGEN_PATH            =
 
 # You can include diagrams made with dia in doxygen documentation. Doxygen will
 # then run dia to produce the diagram and insert it in the documentation. The

cpp/include/cuopt/mathematical_optimization/cuopt_c.h

@@ -934,8 +934,8 @@ void cuOptDestroySolution(cuOptSolution* solution_ptr);
  *
  * @param[in] solution - The solution object.
  *
- * @param[out] termination_reason_ptr - A pointer to a cuopt_int_t that on output will contain the
- *  termination reason.
+ * @param[out] termination_status_ptr - A pointer to a cuopt_int_t that on output will contain the
+ *  termination status.
  *
  * @return A status code indicating success or failure.
  */

docs/cuopt/source/conf.py

@@ -135,12 +135,19 @@
 # a list of builtin themes.
 #
 html_theme = "nvidia_sphinx_theme"
-html_logo = "images/main_nv_logo_square.png"
 html_title = f"{project} ({version})"
 
 autosectionlabel_prefix_document = True
 
 html_theme_options = {
+    "icon_links": [
+        {
+            "name": "GitHub",
+            "url": "https://github.com/NVIDIA/cuopt",
+            "icon": "fa-brands fa-github",
+            "type": "fontawesome",
+        },
+    ],
     "collapse_navigation": False,
     "navigation_depth": 6,
     "switcher": {
@@ -178,11 +185,6 @@
 breathe_domain_by_extension = {"hpp": "cpp", "h": "c", "c": "c"}
 breathe_implementation_filename_extensions = [".cpp", ".cu"]
 
-# Configure Breathe to handle source files
-breathe_projects_source = {
-    "libcuopt": ("../../../cpp/src", ["*.hpp", "*.h", "*.cuh", "*.cu"])
-}
-
 # Configure Breathe to handle CUDA and template attributes
 breathe_doxygen_aliases = {
     "int32_t": "int32_t",
@@ -212,7 +214,7 @@
     (
         master_doc,
         "cuopt.tex",
-        "cuopt Documentation",
+        f"{project} Documentation",
         "NVIDIA Corporation",
         "manual",
     )
@@ -222,7 +224,7 @@
 
 # One entry per manual page. List of tuples
 # (source start file, name, description, authors, manual section).
-man_pages = [(master_doc, "cuopt", "cuopt Documentation", [author], 1)]
+man_pages = [(master_doc, "cuopt", f"{project} Documentation", [author], 1)]
 
 
 # -- Options for Texinfo output -------------------------------------------
@@ -234,7 +236,7 @@
     (
         master_doc,
         "cuopt",
-        "cuopt Documentation",
+        f"{project} Documentation",
         author,
         "cuopt",
         "One line description of project.",