docs: rename lp-qp-milp doc containers to numerical-optimization#1349
Open
rgsl888prabhu wants to merge 2 commits into
Open
docs: rename lp-qp-milp doc containers to numerical-optimization#1349rgsl888prabhu wants to merge 2 commits into
rgsl888prabhu wants to merge 2 commits into
Conversation
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>
WalkthroughDocumentation references and toctree entries are updated to use ChangesDocumentation path migration to numerical-optimization naming
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Suggested labels
Suggested reviewers
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches📝 Generate docstrings
🧪 Generate unit tests (beta)
Comment |
Update the section titles/headers that bundled LP, QP, and MILP together to use the generic "Numerical Optimization" wording, matching the renamed files/directories: - numerical-optimization-settings.rst title - python numerical-optimization-api.rst / -examples.rst titles - c numerical-optimization-c-api.rst title - python & c numerical-optimization/index.rst titles Per-type headers (e.g. MILP Features, LP/QP Features, "Linear Programming (LP)"), toctree captions, and the gRPC routing-vs-numeric contrast labels are left unchanged. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com> Signed-off-by: Ramakrishna Prabhu <ramakrishnap@nvidia.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Renames the grouping documentation directories and consolidated files that bundle LP + QP + MILP together to
numerical-optimization, and updates the corresponding section titles, so adding a new problem type in the future no longer forces renaming/relabeling these containers.File/dir renames
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.rstnumerical-optimization-settings.rstlp-qp-milp-c-api.rstnumerical-optimization-c-api.rstlp-qp-milp-api.rstnumerical-optimization-api.rstlp-qp-milp-examples.rstnumerical-optimization-examples.rstRenames use
git mvso file history is preserved. Alltoctreeentries and:doc:cross-references are updated.Section title updates (LP/QP/MILP -> Numerical Optimization)
Numerical Optimization SettingsNumerical Optimization API Reference(Python)Numerical Optimization Examples(Python)cuOpt Numerical Optimization C API Referencenumerical-optimization/index.rsttitles (Python & C)Scope / out of scope
lp-qp-features.rst,milp-features.rst, per-type example pages and code (simple_lp_example.c, etc.), single-type headers (MILP Features,Linear Programming (LP), ...), toctree captions, and the gRPC routing-vs-numeric contrast labels.skills/still reference the oldlp-qp-milpdoc paths; these will be updated separately, one skill at a time, after this merges.Verification
lp-qp-milpoccurrences underdocs/.toctree/:doc:targets confirmed to exist on disk.🤖 Generated with Claude Code