Skip to content

Align cuOpt documentation branding and Doxygen configuration - #1503

Merged
rapids-bot[bot] merged 1 commit into
NVIDIA:mainfrom
bdice:docs-branding-consistency
Jul 2, 2026
Merged

Align cuOpt documentation branding and Doxygen configuration#1503
rapids-bot[bot] merged 1 commit into
NVIDIA:mainfrom
bdice:docs-branding-consistency

Conversation

@bdice

@bdice bdice commented Jul 2, 2026

Copy link
Copy Markdown
Contributor

Description

  • 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

Checklist

  • I am familiar with the Contributing Guidelines.
  • Testing
    • New or existing tests cover these changes
    • Added tests
    • Created an issue to follow-up
    • NA
  • Documentation
    • The documentation is up to date with these changes
    • Added new documentation
    • NA

@copy-pr-bot

copy-pr-bot Bot commented Jul 2, 2026

Copy link
Copy Markdown

Auto-sync is disabled for draft pull requests in this repository. Workflows must be run manually.

Contributors can view more details about this message here.

@bdice

bdice commented Jul 2, 2026

Copy link
Copy Markdown
Contributor Author

Rendered from efc8619a.

Main page

cuOpt documentation main page

API reference

cuOpt API reference

@bdice
bdice marked this pull request as ready for review July 2, 2026 15:55
@bdice
bdice requested review from a team as code owners July 2, 2026 15:55
@coderabbitai

coderabbitai Bot commented Jul 2, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Enterprise

Run ID: d41f2795-f3ab-4fd6-940b-fe1210199167

📥 Commits

Reviewing files that changed from the base of the PR and between 3f688aa and efc8619.

⛔ Files ignored due to path filters (1)
  • docs/cuopt/source/images/main_nv_logo_square.png is excluded by !**/*.png
📒 Files selected for processing (3)
  • cpp/doxygen/Doxyfile
  • cpp/include/cuopt/mathematical_optimization/cuopt_c.h
  • docs/cuopt/source/conf.py

📝 Walkthrough

Walkthrough

This PR removes several unused Doxyfile configuration options, corrects a documentation parameter name in cuopt_c.h to match the actual API, and updates Sphinx conf.py to use dynamic project-based titles instead of hardcoded strings while adjusting HTML theme options.

Changes

Documentation and Build Configuration Cleanup

Layer / File(s) Summary
Doxyfile configuration cleanup
cpp/doxygen/Doxyfile
Removed TCL_SUBST, an extraneous INPUT entry, CLANG_ASSISTED_PARSING/CLANG_OPTIONS, COLS_IN_ALPHA_INDEX, PERL_PATH, and MSCGEN_PATH settings.
API docstring correction
cpp/include/cuopt/mathematical_optimization/cuopt_c.h
Updated cuOptGetTerminationStatus documentation to reference termination_status_ptr, matching the actual parameter name.
Sphinx conf.py dynamic titles
docs/cuopt/source/conf.py
Removed html_logo, updated html_theme_options/icon_links, and replaced hardcoded "cuopt Documentation" titles with dynamic f-strings across latex_documents, man_pages, and texinfo_documents.

Estimated code review effort: 1 (Trivial) | ~5 minutes

Related Issues: None found.

Related PRs: None found.

Suggested labels: documentation, chore

Suggested reviewers: None determined from available information.


A doc gets tidied, a stray path removed,
A parameter name finally proved,
Titles now flex with the project's own name,
No hardcoded "cuopt" to bear the blame,
Small tweaks, quiet fixes — the build hums approved. 🐇

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly summarizes the main change: documentation branding and Doxygen configuration updates.
Description check ✅ Passed The description matches the changeset, covering branding, Doxygen cleanup, documentation title updates, and parameter-name correction.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

Comment @coderabbitai help to get the list of available commands.

@ramakrishnap-nv ramakrishnap-nv added doc Improvements or additions to documentation improvement Improves an existing functionality labels Jul 2, 2026
@github-actions

github-actions Bot commented Jul 2, 2026

Copy link
Copy Markdown

CI Test Summary

✅ All 31 test job(s) passed.

@ramakrishnap-nv

Copy link
Copy Markdown
Collaborator

/merge

@aliceb-nv aliceb-nv left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Approving the engine typo fix

@rapids-bot
rapids-bot Bot merged commit e34cbb4 into NVIDIA:main Jul 2, 2026
350 of 356 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

doc Improvements or additions to documentation non-breaking Introduces a non-breaking change

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants