Skip to content

docs: rename lp-qp-milp doc containers to numerical-optimization#1349

Open
rgsl888prabhu wants to merge 1 commit into
mainfrom
docs/rename-lp-qp-milp-to-numerical-optimization
Open

docs: rename lp-qp-milp doc containers to numerical-optimization#1349
rgsl888prabhu wants to merge 1 commit into
mainfrom
docs/rename-lp-qp-milp-to-numerical-optimization

Conversation

@rgsl888prabhu
Copy link
Copy Markdown
Collaborator

@rgsl888prabhu rgsl888prabhu commented May 29, 2026

Summary

Renames the grouping documentation directories and consolidated files that bundle LP + QP + MILP together to numerical-optimization, so adding a new problem type in the future no longer forces renaming these containers.

Old New
docs/.../cuopt-c/lp-qp-milp/ docs/.../cuopt-c/numerical-optimization/
docs/.../cuopt-python/lp-qp-milp/ docs/.../cuopt-python/numerical-optimization/
lp-qp-milp-settings.rst numerical-optimization-settings.rst
lp-qp-milp-c-api.rst numerical-optimization-c-api.rst
lp-qp-milp-api.rst numerical-optimization-api.rst
lp-qp-milp-examples.rst numerical-optimization-examples.rst

All toctree entries and :doc: cross-references are updated accordingly. Renames use git mv so file history is preserved.

Scope / out of scope

  • In scope: only the cross-cutting grouping containers (above).
  • Left as-is (per-type pages/examples): lp-qp-features.rst, milp-features.rst, lp-qp-example.rst, milp-examples.rst, lp-examples.rst, the examples/lp/ & examples/milp/ dirs, and individual example code (simple_lp_example.c, etc.) — these genuinely demonstrate one type.
  • Follow-up: skill files under skills/ still reference the old lp-qp-milp doc paths; these will be updated separately, one skill at a time, after this merges.

Rename the grouping doc directories and consolidated files that bundle
LP, QP, and MILP together so adding a new problem type no longer forces
a rename:

  cuopt-c/lp-qp-milp/        -> cuopt-c/numerical-optimization/
  cuopt-python/lp-qp-milp/   -> cuopt-python/numerical-optimization/
  lp-qp-milp-settings.rst    -> numerical-optimization-settings.rst
  lp-qp-milp-c-api.rst       -> numerical-optimization-c-api.rst
  lp-qp-milp-api.rst         -> numerical-optimization-api.rst
  lp-qp-milp-examples.rst    -> numerical-optimization-examples.rst

All toctree entries and :doc: cross-references are updated accordingly.
Per-type pages and example files (e.g. lp-qp-example.rst, milp-examples.rst,
simple_lp_example.c) keep their type-specific names. Skill references to
these paths will be updated separately.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Signed-off-by: Ramakrishna Prabhu <ramakrishnap@nvidia.com>
@rgsl888prabhu rgsl888prabhu requested a review from a team as a code owner May 29, 2026 21:01
@rgsl888prabhu rgsl888prabhu requested a review from tmckayus May 29, 2026 21:01
@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented May 29, 2026

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: 2c679bf4-4e8f-4852-a4f1-1cc4f6337314

📥 Commits

Reviewing files that changed from the base of the PR and between dd11941 and 4976f28.

⛔ Files ignored due to path filters (3)
  • docs/cuopt/source/cuopt-c/numerical-optimization/examples/mip_sample.mps is excluded by !**/*.mps
  • docs/cuopt/source/cuopt-c/numerical-optimization/examples/sample.lp is excluded by !**/*.lp
  • docs/cuopt/source/cuopt-c/numerical-optimization/examples/sample.mps is excluded by !**/*.mps
📒 Files selected for processing (33)
  • docs/cuopt/source/cuopt-c/index.rst
  • docs/cuopt/source/cuopt-c/numerical-optimization/examples/Makefile
  • docs/cuopt/source/cuopt-c/numerical-optimization/examples/lp_file_example.c
  • docs/cuopt/source/cuopt-c/numerical-optimization/examples/milp_mps_example.c
  • docs/cuopt/source/cuopt-c/numerical-optimization/examples/mps_file_example.c
  • docs/cuopt/source/cuopt-c/numerical-optimization/examples/simple_lp_example.c
  • docs/cuopt/source/cuopt-c/numerical-optimization/examples/simple_milp_example.c
  • docs/cuopt/source/cuopt-c/numerical-optimization/examples/simple_qp_example.c
  • docs/cuopt/source/cuopt-c/numerical-optimization/index.rst
  • docs/cuopt/source/cuopt-c/numerical-optimization/lp-qp-example.rst
  • docs/cuopt/source/cuopt-c/numerical-optimization/milp-examples.rst
  • docs/cuopt/source/cuopt-c/numerical-optimization/numerical-optimization-c-api.rst
  • docs/cuopt/source/cuopt-cli/quick-start.rst
  • docs/cuopt/source/cuopt-grpc/examples.rst
  • docs/cuopt/source/cuopt-grpc/quick-start.rst
  • docs/cuopt/source/cuopt-python/index.rst
  • docs/cuopt/source/cuopt-python/numerical-optimization/examples/expressions_constraints_example.py
  • docs/cuopt/source/cuopt-python/numerical-optimization/examples/incumbent_solutions_example.py
  • docs/cuopt/source/cuopt-python/numerical-optimization/examples/pdlp_warmstart_example.py
  • docs/cuopt/source/cuopt-python/numerical-optimization/examples/production_planning_example.py
  • docs/cuopt/source/cuopt-python/numerical-optimization/examples/qp_matrix_example.py
  • docs/cuopt/source/cuopt-python/numerical-optimization/examples/semi_continuous_example.py
  • docs/cuopt/source/cuopt-python/numerical-optimization/examples/simple_lp_example.py
  • docs/cuopt/source/cuopt-python/numerical-optimization/examples/simple_milp_example.py
  • docs/cuopt/source/cuopt-python/numerical-optimization/examples/simple_qp_example.py
  • docs/cuopt/source/cuopt-python/numerical-optimization/examples/solution_example.py
  • docs/cuopt/source/cuopt-python/numerical-optimization/index.rst
  • docs/cuopt/source/cuopt-python/numerical-optimization/numerical-optimization-api.rst
  • docs/cuopt/source/cuopt-python/numerical-optimization/numerical-optimization-examples.rst
  • docs/cuopt/source/cuopt-server/examples/lp-examples.rst
  • docs/cuopt/source/cuopt-server/server-api/index.rst
  • docs/cuopt/source/numerical-optimization-settings.rst
  • docs/cuopt/source/transition.rst

📝 Walkthrough

Walkthrough

Documentation references throughout the cuOpt API guides are systematically updated to use numerical-optimization naming instead of lp-qp-milp. Toctree entries and cross-references in C, Python, CLI, gRPC, and Server documentation are aligned with the new path structure.

Changes

Documentation path migration to numerical-optimization naming

Layer / File(s) Summary
C API documentation structure and content updates
docs/cuopt/source/cuopt-c/index.rst, docs/cuopt/source/cuopt-c/numerical-optimization/index.rst, docs/cuopt/source/cuopt-c/numerical-optimization/lp-qp-example.rst, docs/cuopt/source/cuopt-c/numerical-optimization/milp-examples.rst, docs/cuopt/source/cuopt-c/numerical-optimization/numerical-optimization-c-api.rst
C API index structure and example content files are updated to reference numerical-optimization instead of lp-qp-milp in toctree entries and documentation links.
Python API documentation structure updates
docs/cuopt/source/cuopt-python/index.rst, docs/cuopt/source/cuopt-python/numerical-optimization/index.rst
Python API index and nested documentation index are updated to point to numerical-optimization-api.rst and numerical-optimization-examples.rst instead of the prior lp-qp-milp files.
Cross-API documentation reference updates
docs/cuopt/source/cuopt-cli/quick-start.rst, docs/cuopt/source/cuopt-grpc/examples.rst, docs/cuopt/source/cuopt-grpc/quick-start.rst, docs/cuopt/source/cuopt-server/examples/lp-examples.rst, docs/cuopt/source/cuopt-server/server-api/index.rst, docs/cuopt/source/numerical-optimization-settings.rst, docs/cuopt/source/transition.rst
CLI, gRPC, Server, and shared settings documentation pages are updated to point to the new numerical-optimization-settings and numerical-optimization-c-api paths in toctree entries and content cross-references.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Suggested labels

non-breaking, improvement

Suggested reviewers

  • tmckayus
  • Iroy30
🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title accurately summarizes the main change: renaming documentation containers from 'lp-qp-milp' to 'numerical-optimization' across the documentation structure.
Description check ✅ Passed The description is directly related to the changeset, providing clear rationale (avoid future renames), detailed mapping of renamed files/directories, and scope clarification distinguishing in-scope container renames from excluded per-type pages.
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.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/rename-lp-qp-milp-to-numerical-optimization

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant