Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
15 changes: 15 additions & 0 deletions docs/AGENTS.md
Original file line number Diff line number Diff line change
Expand Up @@ -100,3 +100,18 @@ and `logo_dark`.

Keep cache-removal documentation focused on migration impact. Omit asset-fetch
implementation walkthroughs and alternative override instructions.

## RST restructuring

When moving a guide, keep its setup content until any deferred replacement pages
exist. Preserve old URLs with compatibility pages and retain explicit labels in
the destination. Recompute RST heading underlines when renaming their text.
Device metadata containing docnames must come from `app.srcdir` so a multiversion
build uses paths that exist in that ref, even when `conf.py` comes from the deploy
checkout.

Reuse the README architecture image in the RST overview so both entry points
share one maintained diagram.

Group vendor device guides under category toctrees in the Devices navigation;
folder placement alone does not create sidebar nesting.
2 changes: 1 addition & 1 deletion docs/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
<!DOCTYPE html>
<html>
<head>
<title>Redirecting to the latest Isaac Teleop documentation</title>
<title>Redirecting to the latest Isaac Capture documentation</title>
<meta charset="utf-8">
<meta http-equiv="refresh" content="0; url=./main/index.html">
</head>
Expand Down
16 changes: 8 additions & 8 deletions docs/source/_data/devices.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -139,7 +139,7 @@ devices:
details:
setup:
- label: Body Tracking guide
doc: /device/body_tracking
doc: /device/body_tracking/index
- Isaac Teleop Web Client
requirements:
- >-
Expand Down Expand Up @@ -192,7 +192,7 @@ devices:
- label: MANUS Gloves Plugin
url: https://github.com/NVIDIA/IsaacTeleop/tree/main/src/plugins/manus
- label: MANUS Gloves docs
doc: /device/manus
doc: /device/hand_tracking/manus
requirements:
- MANUS SDK
- USB receiver on the workstation
Expand All @@ -216,7 +216,7 @@ devices:
- label: Haptikos Plugin
url: https://github.com/NVIDIA/IsaacTeleop/tree/main/src/plugins/haptikos
- label: Haptikos docs
doc: /device/haptikos
doc: /device/hand_tracking/haptikos
requirements:
- Haptikos Robotics API
acquire:
Expand All @@ -238,7 +238,7 @@ devices:
- label: OGLO Tactile Glove Plugin
url: https://github.com/NVIDIA/IsaacTeleop/tree/main/src/plugins/oglo_tactile
- label: OGLO Tactile Glove docs
doc: /device/oglo
doc: /device/tactile/oglo
requirements:
- Linux with BlueZ
- One BLE device per glove
Expand All @@ -257,7 +257,7 @@ devices:
details:
setup:
- label: WUJI Glove docs
doc: /device/wuji_glove
doc: /device/hand_tracking/wuji_glove
- label: WUJI Glove Plugin
url: https://github.com/NVIDIA/IsaacTeleop/tree/main/src/plugins/wuji_glove
- label: WUJI Hand retargeting
Expand Down Expand Up @@ -309,7 +309,7 @@ devices:
- label: SpaceMouse Plugin
url: https://github.com/NVIDIA/IsaacTeleop/tree/main/src/plugins/spacemouse
- label: SpaceMouse docs
doc: /device/spacemouse
doc: /device/spatial_controllers/spacemouse
requirements:
- Linux workstation with USB or the 3Dconnexion Universal Receiver
- Plugin udev rule installed on the host
Expand Down Expand Up @@ -344,7 +344,7 @@ devices:
- label: OAK-D Camera Plugin
url: https://github.com/NVIDIA/IsaacTeleop/tree/main/src/plugins/oak
- label: OAK Camera docs
doc: /device/oak
doc: /device/cameras/oak
requirements:
- USB 3 connection to the workstation
acquire:
Expand All @@ -365,7 +365,7 @@ devices:
details:
setup:
- label: LeRobot integration
doc: /getting_started/lerobot/index
doc: /integrations/lerobot/index
- label: LeRobot on GitHub
url: https://github.com/huggingface/lerobot

Expand Down
17 changes: 9 additions & 8 deletions docs/source/_ext/ecosystem_grid.py
Original file line number Diff line number Diff line change
Expand Up @@ -34,10 +34,10 @@
# an earlier tag is listed from here rather than from a 0.x version.
SINCE_FLOOR = "v1.0.191"

# A link into the docs site or into the IsaacTeleop repository stays inside this
# A link into the docs site or into the Isaac Capture repository stays inside this
# project, so it carries no external marker -- arrow or screen-reader label. Every
# other domain gets one, including other GitHub organizations such as isaac-sim.
PROJECT_REPO = "https://github.com/NVIDIA/IsaacTeleop"
PROJECT_REPO = "https://github.com/NVIDIA/IsaacCapture"

# Group header rows within a table. The input wording is the old page's own table
# titles, so a reader arriving from an old link recognizes them.
Expand Down Expand Up @@ -407,11 +407,10 @@ def _load_devices(env, relpath: str = DEVICE_DATA) -> tuple[list[dict], list[dic
dependency, an incremental build reuses the cached doctree and renders the previous
table after the data changes.
"""
confdir = env.app.confdir
env.note_dependency(os.path.join(confdir, relpath))
return _read(
confdir, relpath, lambda data: _validate_devices(data, relpath, confdir)
)
# Device docnames must match the ref being built, not the deploy config's ref.
srcdir = env.app.srcdir
env.note_dependency(os.path.join(srcdir, relpath))
return _read(srcdir, relpath, lambda data: _validate_devices(data, relpath, srcdir))


def _line(classes: list[str], text: str = "") -> nodes.paragraph:
Expand All @@ -423,7 +422,9 @@ def _line(classes: list[str], text: str = "") -> nodes.paragraph:


def _is_external(url: str) -> bool:
return not str(url).startswith(PROJECT_REPO)
return not str(url).startswith(
(PROJECT_REPO, "https://github.com/NVIDIA/IsaacTeleop")
)


def _mark_external(ref: nodes.Element, *, arrow: bool = True) -> None:
Expand Down
12 changes: 6 additions & 6 deletions docs/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@

# -- Project information -----------------------------------------------------

project = "Isaac Teleop"
project = "Isaac Capture"
build_time = datetime.now(timezone.utc)
copyright = f"2025-{build_time.year}, NVIDIA CORPORATION & AFFILIATES"
copyright += f", last updated on {build_time.strftime('%B %d, %Y')}"
Expand Down Expand Up @@ -86,7 +86,7 @@ def _pip_pin(ref_name, fallback):

# -- Options for HTML output ---------------------------------------------------

html_title = "Isaac Teleop Documentation"
html_title = "Isaac Capture Documentation"
html_theme = "nvidia_sphinx_theme"
html_favicon = "_static/favicon.ico"
html_show_copyright = True
Expand All @@ -101,7 +101,7 @@ def _pip_pin(ref_name, fallback):

_DEFAULT_ICONS = {
"teleop_version": "main",
"teleop_url": "https://github.com/NVIDIA/IsaacTeleop",
"teleop_url": "https://github.com/NVIDIA/IsaacCapture",
"cloudxr_version": "6.2",
"cloudxr_url": "https://docs.nvidia.com/cloudxr-sdk",
"lab_version": "3.0",
Expand All @@ -110,7 +110,7 @@ def _pip_pin(ref_name, fallback):
_VERSION_ICON_MAP = {
"release/1.0.x": {
"teleop_version": "1.0",
"teleop_url": "https://github.com/NVIDIA/IsaacTeleop/tree/release/1.0.x",
"teleop_url": "https://github.com/NVIDIA/IsaacCapture/tree/release/1.0.x",
"cloudxr_version": "6.1",
"cloudxr_url": "https://docs.nvidia.com/cloudxr-sdk/release/6",
"lab_version": "3.0",
Expand Down Expand Up @@ -197,13 +197,13 @@ def _versioning_context(app, pagename, templatename, context, doctree):
# Edit page button: link to GitHub so users can suggest edits (PyData theme uses html_context)
html_context = {
"github_user": "NVIDIA",
"github_repo": "IsaacTeleop",
"github_repo": "IsaacCapture",
"github_version": _smv_name or "main",
"doc_path": "docs/source",
}

# Base URL for linking to repository source (used by code-file and code-dir roles).
_GH_BASE = "https://github.com/NVIDIA/IsaacTeleop"
_GH_BASE = "https://github.com/NVIDIA/IsaacCapture"
_GH_BRANCH = html_context["github_version"]


Expand Down
Loading
Loading