Skip to content

Fixing broken links #1028

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
rapids-bot merged 1 commit into from
Apr 2, 2026
Merged

Fixing broken links #1028

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/cuopt/source/cuopt-c/lp-qp-milp/lp-qp-example.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -91,7 +91,7 @@ If you have built it locally, libcuopt.so will be in the build directory ``cpp/b
# Find the libcuopt library and assign to LIBCUOPT_LIBRARY_PATH
LIBCUOPT_LIBRARY_PATH=$(find / -name "libcuopt.so" 2>/dev/null)

A sample MPS file (:download:`download sample.mps <examples/sample.mps>`):
A sample MPS file (:download:`download sample.mps <https://raw.githubusercontent.com/BUGSENG/PPL/devel/demos/ppl_lpsol/examples/sample.mps>`):
Copy link
Copy Markdown

@coderabbitai coderabbitai bot Apr 1, 2026

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🟠 Major

Download target should match the literalincluded sample file.

At Line 94, the external sample.mps may differ from the local examples/sample.mps shown at Line 96 and used for the documented output, which can break the example flow.

Suggested fix 
-A sample MPS file (:download:`download sample.mps <https://raw.githubusercontent.com/BUGSENG/PPL/devel/demos/ppl_lpsol/examples/sample.mps>`):
+A sample MPS file (:download:`download sample.mps <examples/sample.mps>`):

As per coding guidelines: docs/**/*: “Accuracy: Verify code examples compile and run correctly” and “Consistency: Version numbers, parameter types, and terminology match code.”

📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
A sample MPS file (:download:`download sample.mps <https://raw.githubusercontent.com/BUGSENG/PPL/devel/demos/ppl_lpsol/examples/sample.mps>`):
A sample MPS file (:download:`download sample.mps <examples/sample.mps>`):
🤖 Prompt for AI Agents 
Verify each finding against the current code and only fix it if needed.

In `@docs/cuopt/source/cuopt-c/lp-qp-milp/lp-qp-example.rst` at line 94, The
external download link for "sample.mps" in the sentence starting with "A sample
MPS file (:download:`download sample.mps ..." does not match the
locally-included example used later ("examples/sample.mps"); update the download
target so it points to the same literal file used by the documentation (replace
the raw GitHub URL with the repository path/version that corresponds to the
local examples/sample.mps or use a literalinclude/reference to the same
examples/sample.mps), ensuring the URL/target and the local example name
"sample.mps" are identical so the downloaded file and the documented output
remain consistent.


.. literalinclude:: examples/sample.mps
:language: text
Expand Down
2 changes: 1 addition & 1 deletion docs/cuopt/source/cuopt-c/lp-qp-milp/milp-examples.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -98,7 +98,7 @@ If you have built it locally, libcuopt.so will be in the build directory ``cpp/b
# Find the libcuopt library and assign to LIBCUOPT_LIBRARY_PATH
LIBCUOPT_LIBRARY_PATH=$(find / -name "libcuopt.so" 2>/dev/null)

A sample MILP MPS file (:download:`download mip_sample.mps <examples/mip_sample.mps>`):
A sample MILP MPS file (:download:`download mip_sample.mps <https://raw.githubusercontent.com/coin-or/SYMPHONY/master/Datasets/sample.mps>`):
Copy link
Copy Markdown

@coderabbitai coderabbitai bot Apr 1, 2026

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🟠 Major

Keep the downloadable MPS file aligned with the included sample.

Line 101 now downloads an external file, while Line 103 and the expected output still correspond to examples/mip_sample.mps. This can make the walkthrough non-reproducible for users.

Suggested fix 
-A sample MILP MPS file (:download:`download mip_sample.mps <https://raw.githubusercontent.com/coin-or/SYMPHONY/master/Datasets/sample.mps>`):
+A sample MILP MPS file (:download:`download mip_sample.mps <examples/mip_sample.mps>`):

As per coding guidelines: docs/**/*: “Accuracy: Verify code examples compile and run correctly” and “Consistency: Version numbers, parameter types, and terminology match code.”

📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
A sample MILP MPS file (:download:`download mip_sample.mps <https://raw.githubusercontent.com/coin-or/SYMPHONY/master/Datasets/sample.mps>`):
A sample MILP MPS file (:download:`download mip_sample.mps <examples/mip_sample.mps>`):
🤖 Prompt for AI Agents 
Verify each finding against the current code and only fix it if needed.

In `@docs/cuopt/source/cuopt-c/lp-qp-milp/milp-examples.rst` at line 101, The docs
currently reference an external download tag "download mip_sample.mps
<https://raw.githubusercontent.com/coin-or/SYMPHONY/master/Datasets/sample.mps>"
while the text and expected output refer to the local file
examples/mip_sample.mps, causing a mismatch; update the download directive so it
points to the same file used by the examples (replace the external URL with the
repository-local examples/mip_sample.mps path) or alternatively change the
example references and expected output to match the external sample.mps
URL—ensure the token "mip_sample.mps" and all occurrences of
"examples/mip_sample.mps" and the download directive are made consistent.


.. literalinclude:: examples/mip_sample.mps
:language: text
Expand Down
2 changes: 1 addition & 1 deletion docs/cuopt/source/cuopt-python/routing/routing-example.ipynb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -147,7 +147,7 @@
"metadata": {},
"source": [
"#### Compressed Sparse Row (CSR) representation of above weighted waypoint graph.\n",
"For details on the CSR encoding of the above graph see the [cost_matrix_and_waypoint_graph_creation.ipynb](https://github.com/NVIDIA/cuopt-examples/blob/release/26.04/intra-factory_transport/cost_matrix_and_waypoint_graph_creation.ipynb) notebook."
"For details on the CSR encoding of the above graph see the [cost_matrix_and_waypoint_graph_creation.ipynb](https://github.com/NVIDIA/cuopt-examples/blob/main/intra-factory_transport/cost_matrix_and_waypoint_graph_creation.ipynb) notebook."
]
},
{
Expand Down
2 changes: 1 addition & 1 deletion docs/cuopt/source/cuopt-server/examples/lp-examples.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -407,7 +407,7 @@ In the case of batch mode, you can send a bunch of ``mps`` files at once, and ac
.. note::
Batch mode is not available for MILP problems.

A sample MPS file (:download:`sample.mps <lp/examples/sample.mps>`):
A sample MPS file (:download:`sample.mps <https://people.math.sc.edu/Burkardt/datasets/mps/testprob.mps>`):
Copy link
Copy Markdown

@coderabbitai coderabbitai bot Apr 1, 2026

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🟠 Major

Use the same MPS artifact for display, download, and CLI steps.

Line 410 points to an external dataset, but Line 412 and the example commands use local sample.mps. This introduces a docs mismatch and can produce different solver results than the documented response.

Suggested fix 
-A sample MPS file (:download:`sample.mps <https://people.math.sc.edu/Burkardt/datasets/mps/testprob.mps>`):
+A sample MPS file (:download:`sample.mps <lp/examples/sample.mps>`):

As per coding guidelines: docs/**/*: “Accuracy: Verify code examples compile and run correctly” and “Consistency: Version numbers, parameter types, and terminology match code.”

📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
A sample MPS file (:download:`sample.mps <https://people.math.sc.edu/Burkardt/datasets/mps/testprob.mps>`):
A sample MPS file (:download:`sample.mps <lp/examples/sample.mps>`):
🤖 Prompt for AI Agents 
Verify each finding against the current code and only fix it if needed.

In `@docs/cuopt/source/cuopt-server/examples/lp-examples.rst` at line 410, The
docs currently reference an external MPS URL in the display/download text but
use a local file name `sample.mps` in the subsequent CLI and example commands,
causing inconsistency; update the examples so the same artifact is used
everywhere—either change the download/display link to point to the local
`sample.mps` artifact or update the CLI/example commands to reference the
external URL—ensure all occurrences of `sample.mps`, the download link
(https://people.math.sc.edu/Burkardt/datasets/mps/testprob.mps), and any CLI
example lines use the identical artifact reference so displayed, downloaded, and
executed inputs are the same.


.. literalinclude:: lp/examples/sample.mps
:language: text
Expand Down
2 changes: 1 addition & 1 deletion docs/cuopt/source/faq.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -283,7 +283,7 @@ Routing FAQ

So in either case, task locations are actually integer indices into another structure.

If you have (lat, long) values, then you can generate a cost matrix using a map API. cuOpt does not directly connect to a third-party map engine, but that can be done outside of cuOpt as shown `here <https://github.com/NVIDIA/cuOpt-Resources/blob/release/26.04/notebooks/routing/service/cost_matrix_creation.ipynb>`__.
If you have (lat, long) values, then you can generate a cost matrix using a map API. cuOpt does not directly connect to a third-party map engine, but that can be done outside of cuOpt as shown `here <https://github.com/NVIDIA/cuopt-examples/blob/branch-23.10/notebooks/routing/service/cost_matrix_creation.ipynb>`__.

.. dropdown:: Is it possible to define constraints such as refrigerated vehicles required for certain orders?

Expand Down
Loading