Skip to content

docs: call out python venv in quick start#458

Open
jiwenc-nv wants to merge 1 commit intoNVIDIA:mainfrom
jiwenc-nv:jiwenc/docs-improve-venv
Open

docs: call out python venv in quick start#458
jiwenc-nv wants to merge 1 commit intoNVIDIA:mainfrom
jiwenc-nv:jiwenc/docs-improve-venv

Conversation

@jiwenc-nv
Copy link
Copy Markdown
Collaborator

@jiwenc-nv jiwenc-nv commented May 1, 2026

Fixes: #453

Summary by CodeRabbit

  • Documentation
    • Enhanced getting started guide with guidance on using isolated Python environments during installation.
    • Added beginner-friendly explanation for those new to Python environments with a minimal setup workflow.
    • Extended reference section with additional documentation links for environment management tools.

@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-458/

@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: a9783331-43ad-498a-b3c1-0aa8d25e6131

📥 Commits

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

📒 Files selected for processing (1)
  • docs/source/getting_started/quick_start.rst

📝 Walkthrough

Walkthrough

The quick-start documentation for isaacteleop now includes guidance to use an isolated Python environment before installation. A new expandable section titled "New to Python environments?" provides a minimal workflow using uv for environment setup. The "More Information" reference section is extended with links to documentation for uv, conda, and Python's venv module to support the newly introduced inline references.

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 title accurately describes the main change: adding Python virtual environment guidance to the quick start documentation.
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

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

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

@jiwenc-nv
Copy link
Copy Markdown
Collaborator Author

/preview-docs

@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented May 1, 2026

❌ No successful Build & deploy docs run found for commit e847dcec. Wait for the build to finish (or push a commit that touches docs/ to trigger one), then re-comment /preview-docs.

@jiwenc-nv jiwenc-nv requested review from aristarkhovNV and yanziz-nvidia and removed request for yanziz-nvidia May 1, 2026 22:53
@jiwenc-nv
Copy link
Copy Markdown
Collaborator Author

/preview-docs

@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented May 1, 2026

✅ Preview deployed: https://NVIDIA.github.io/IsaacTeleop/preview/pr-458/

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.

Quick Start guide missing step: activate virtual environment before pip install

1 participant