Enable agent-friendly documentation output

[jacobtomlinson]

Description

This PR adds the sphinx-llm extension which generates markdown pages in the documentation build output that conform to the llms.txt spec.

This means an agent should be able to visit /llms.txt on your site to get a markdown sitemap, and each page should be published in markdown in addition to HTML to help reduce context/token usage. For example /overview.html also gets published as /overview.md with the same content in markdown, and the /llms.txt sitemap points to /overview.md with a short summary of that page. The HTML page contains meta headers to help agents discover markdown versions if they find the HTML via search.

sphinx-llm works by running the sphinx-markdown-builder in parallel to the primary docs build so that the output of extensions like docref/autodoc/intersphinx/etc is fully rendered in the markdown output. Then it merges the two build outputs following the llms.txt structure.

Note

Optionally, sphinx-llm can also use an LLM during the documentation build to generate richer summaries of pages and compact documentation details into the /llms.txt file to aid agent discovery. However, this PR does not enable this at this time as it requires configuring a model endpoint and credentials and will consume tokens during each docs build in CI. This could be enabled in the future after further discussion.

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

[coderabbitai]

Understand this PR’s impact

Explore downstream dependencies and potential security impact with Blast Radius.

View blast radius →

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: Repository: NVIDIA/cuopt/.coderabbit.yaml

Review profile: CHILL

Plan: Enterprise

Run ID: 04e9d826-683b-4918-999b-4cc61b5ced3d

📥 Commits

Reviewing files that changed from the base of the PR and between 8f96c45 and 3c3d6d1.

📒 Files selected for processing (5)

• conda/environments/all_cuda-129_arch-aarch64.yaml
• conda/environments/all_cuda-129_arch-x86_64.yaml
• conda/environments/all_cuda-133_arch-aarch64.yaml
• conda/environments/all_cuda-133_arch-x86_64.yaml
• dependencies.yaml

Included review availability: Your plan provides up to 12 included reviews per hour; 8 remain after this review.

---

📝 Walkthrough

Walkthrough

The change adds sphinx-llm>=1.1.0 to documentation dependencies and four CUDA environment definitions. The Sphinx configuration enables the sphinx_llm.txt extension.

Changes

Documentation support

Layer / File(s)	Summary
Register sphinx-llm dependencies dependencies.yaml, conda/environments/all_cuda-129_arch-*.yaml, conda/environments/all_cuda-133_arch-*.yaml	The documentation dependency list and four CUDA environment files now include sphinx-llm>=1.1.0.
Enable the Sphinx extension docs/cuopt/source/conf.py	The Sphinx extensions list now includes sphinx_llm.txt.

Priority: ⬇️ Low

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

Change: Feature

Merge Risk: ⚪ Minimal · up to 3c3d6

No supported merge-blocking risk remains.

🚥 Pre-merge checks | ✅ 5

✅ Passed checks (5 passed)

Check name	Status	Explanation
Title check	✅ Passed	The title clearly describes the main change: enabling agent-friendly documentation output through the documentation build.
Description check	✅ Passed	The description directly explains the addition of sphinx-llm, the generated llms.txt output, Markdown pages, and the build behavior.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 1…
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 💡 1

🛠️ Fix failing CI checks 💡

• Commit to this branch
• Create a new PR

🧪 Generate unit tests (beta)

• Create a new PR

---

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

[github-actions]

CI Test Summary

✅ All 13 test job(s) passed. (2 skipped)