Skip to content

docs: support NVIDIA 595 and refresh documentation - #524

Merged
yuecideng merged 1 commit into
mainfrom
codex/docs-nvidia-595
Aug 19, 2026
Merged

docs: support NVIDIA 595 and refresh documentation#524
yuecideng merged 1 commit into
mainfrom
codex/docs-nvidia-595

Conversation

@yuecideng

Copy link
Copy Markdown
Contributor

Description

Refresh the installation guide and the broader documentation set for the current EmbodiChain codebase.

  • Document NVIDIA driver 595 support while retaining the CUDA 12.x/PyTorch compatibility baseline.
  • Select cuRobo wheels from torch.version.cuda instead of the host driver's advertised CUDA level.
  • Pin a compatible Sphinx toolchain and document the strict local docs build workflow.
  • Repair stale links, malformed markup, Sphinx warnings, and outdated examples.
  • Expand the task, robot, and workspace sampler references, and correct docstrings that broke API parsing.

No runtime dependency is added. Documentation build dependencies are pinned for reproducibility.

Related issue: none.

Type of change

  • Documentation update

Screenshots

Not applicable; this PR changes prose, references, and build configuration without introducing a new visual UI.

Validation

  • black --check --diff --color ./ (914 files unchanged; Black 26.3.1)
  • pytest -q tests/docs (12 passed)
  • python docs/scripts/sync_readme.py --check
  • git diff --check
  • Strict Sphinx HTML build with -W (API reference excluded because the local dexsim_engine runtime is unavailable)
  • Sphinx link check over the same documentation scope

Checklist

  • I have run the Black formatting check across the code base.
  • I have made corresponding changes to the documentation.
  • I have added tests that prove my fix is effective or that my feature works. Existing documentation tests cover this documentation-only change.
  • Dependencies have been updated, where applicable.

Document NVIDIA 595 support while retaining the CUDA 12.x stack, pin a compatible Sphinx toolchain, repair stale links and warnings, and expand the task, robot, and workspace references.
@yuecidengyuecideng added docs Improvements or additions to documentation dependencies Pull requests that update a dependency file labels Aug 19, 2026
@yuecideng
yuecideng merged commit dbc6553 into mainAug 19, 2026
2 checks passed
@yuecideng
yuecideng deleted the codex/docs-nvidia-595 branch August 19, 2026 05:47
@greptile-apps

Copy link
Copy Markdown

Greptile Summary

This PR refreshes installation and API documentation, pins the Sphinx toolchain, updates NVIDIA 595 and cuRobo compatibility guidance, and corrects documentation markup and references.

  • Pins documentation dependencies and updates Sphinx/MyST theme configuration.
  • Expands task, robot, and workspace sampler references.
  • Corrects CLI examples, internal links, docstrings, and API parsing markup.
  • Adds a documentation setup command that currently relies on an unauthenticated package index.

Confidence Score: 3/5

The PR should not merge until the documentation installation command stops trusting a plaintext package index, which currently permits dependency substitution and code execution.

The newly documented setup path sends pip dependency resolution to an unauthenticated HTTP source and explicitly trusts it, exposing every developer or CI job following the guide to attacker-supplied package content.

Files Needing Attention: docs/source/quick_start/docs.md

Security Review

The new documentation setup command installs dependencies from a plaintext HTTP package index marked as trusted. Anyone able to alter that network traffic can substitute installable package content and execute code on a developer or CI documentation builder.

Important Files Changed

FilenameOverview
docs/source/quick_start/docs.mdAdds a reproducible local documentation workflow, but its project installation command trusts a plaintext package index and enables package-substitution attacks.
docs/requirements.txtReplaces broad documentation dependency requirements with exact Sphinx toolchain pins; no reachable use of the reported vulnerable transitive IDNA API was established.
docs/source/conf.pyUpdates MyST heading anchors and switches to theme-native navigation options compatible with the pinned documentation theme.
docs/source/quick_start/install.mdDocuments NVIDIA 595 compatibility and correctly bases cuRobo wheel selection on PyTorch's CUDA runtime rather than the host driver's advertised capability.
docs/source/features/workspace_analyzer/samplers.mdExpands sampler documentation and factory examples consistently with the current strategy registrations and constructor interfaces.
docs/source/resources/task/index.rstAdds a detailed task and configuration catalog; no concrete broken reference was established.
embodichain/utils/cfg.pyClarifies configurable decorator API documentation without changing runtime behavior.
embodichain/utils/img_utils.pyExpands image utility docstrings without changing implementation behavior.

Fix all with GreploopFix All in CodexFix All in Claude Code

Prompt To Fix All With AI
### Issue 1
docs/source/quick_start/docs.md:10-13
**Unauthenticated package installation source**
If a developer or CI job follows this setup command over an attacker-controlled network, pip trusts dependency metadata and artifacts retrieved from the plaintext HTTP index, allowing substituted package content to execute during installation.
**How this was verified:** The documented HTTP package source flows directly into pip installation with transport authentication disabled.
---
For each issue above, determine whether it is valid and should be fixed. If so, fix it directly.

Reviews (1): Last reviewed commit: "docs: update GPU compatibility and docum..." | Re-trigger Greptile

Comment on lines +10 to +13
pip install -e ".[gensim]" \
--extra-index-url http://pyp.open3dv.site:2345/simple/ \
--trusted-host pyp.open3dv.site \
--extra-index-url https://download.blender.org/pypi/

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

P1securityUnauthenticated package installation source

If a developer or CI job follows this setup command over an attacker-controlled network, pip trusts dependency metadata and artifacts retrieved from the plaintext HTTP index, allowing substituted package content to execute during installation.

How this was verified: The documented HTTP package source flows directly into pip installation with transport authentication disabled.

Prompt To Fix With AI
This is a comment left during a code review.
Path: docs/source/quick_start/docs.md
Line: 10-13
Comment:
**Unauthenticated package installation source**
If a developer or CI job follows this setup command over an attacker-controlled network, pip trusts dependency metadata and artifacts retrieved from the plaintext HTTP index, allowing substituted package content to execute during installation.
**How this was verified:** The documented HTTP package source flows directly into pip installation with transport authentication disabled.
---
For each issue above, determine whether it is valid and should be fixed. If so, fix it directly.

Fix in CodexFix in Claude Code

Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

dependenciesPull requests that update a dependency filedocsImprovements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant

@yuecideng