Skip to content

docs: add nlopt system dependency prerequisite#456

Closed
alceops wants to merge 1 commit into
NVIDIA:mainfrom
alceops:alce/docs-libnlopt-prereq-452
Closed

docs: add nlopt system dependency prerequisite#456
alceops wants to merge 1 commit into
NVIDIA:mainfrom
alceops:alce/docs-libnlopt-prereq-452

Conversation

@alceops
Copy link
Copy Markdown

@alceops alceops commented May 1, 2026

Summary

  • document libnlopt-dev as an Ubuntu prerequisite when nlopt has to build from source
  • add the same prerequisite to the Quick Start pip install path and Build from Source apt package list

Fixes #452.

Verification

  • git diff --check
  • confirmed both updated getting-started docs mention libnlopt-dev

Note: pre-commit is not installed in my local environment, so I could not run the repository pre-commit hook set.

Summary by CodeRabbit

  • Documentation
    • Updated build-from-source documentation to explicitly require NLopt development headers when building Python bindings with NLopt support
    • Enhanced quick-start guide with Ubuntu system dependency installation step for the required libnlopt-dev package
    • Aligned prerequisite requirements across documentation for consistent setup instructions

@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented May 1, 2026

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: a2d649e1-2d99-4352-be9d-51cdf92e5ad8

📥 Commits

Reviewing files that changed from the base of the PR and between a939dd1 and 970a937.

📒 Files selected for processing (2)
  • docs/source/getting_started/build_from_source/index.rst
  • docs/source/getting_started/quick_start.rst

📝 Walkthrough

Walkthrough

Documentation updates to address a missing system dependency prerequisite. The guides for Quick Start and Build from Source now explicitly document the requirement for libnlopt-dev development headers on Ubuntu systems, since the nlopt Python package may fall back to building from source (particularly on aarch64 platforms where pre-built wheels are unavailable). The updates include adding the system package name to the prerequisites list and inserting an installation step with the appropriate apt-get command.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The pull request title 'docs: add nlopt system dependency prerequisite' accurately describes the main change of documenting the libnlopt-dev system dependency in the Quick Start and Build from Source guides.
Linked Issues check ✅ Passed The pull request successfully addresses issue #452 by adding libnlopt-dev documentation to both the Quick Start and Build from Source guides, resolving the undocumented system dependency that caused nlopt wheel build failures.
Out of Scope Changes check ✅ Passed All changes in the pull request are directly scoped to documenting the libnlopt-dev system dependency in the Quick Start and Build from Source guides as required by issue #452.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

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

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

Review rate limit: 9/10 reviews remaining, refill in 6 minutes.

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

@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented May 1, 2026

📝 Docs preview is not auto-deployed for fork PRs.

A maintainer with write access to NVIDIA/IsaacTeleop can deploy a preview by
commenting /preview-docs on this PR. Once deployed, the preview
will live at:

https://nvidia.github.io/IsaacTeleop/preview/pr-456/

@jiwenc-nv
Copy link
Copy Markdown
Collaborator

that's not the real fix. the original issue #452 is something specific to a special hardware.

@jiwenc-nv jiwenc-nv closed this May 1, 2026
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.

libnlopt-dev system dependency undocumented in Quick Start and Build from Source guides

2 participants