Skip to content

Commit 3189544

Browse files
committed
docs: fix broken links found by linkcheck
- Drop the Module Index link from the root page: no Python modules are documented, so Sphinx never generates py-modindex.html. - Fix the DeviceIOSession source link to the current src/core/deviceio_session/ path. - Remove the reference to cmake/SetupHunter.cmake, which does not exist; the documented options live in CMakeLists.txt and SetupPython.cmake. - Collapse whitespace in the code-file/code-dir role parser so line-wrapped 'label <path>' targets parse correctly (fixes a mangled replay.yaml link on the camera streaming page). - Render the viser localhost URL as an inline literal instead of an auto-generated hyperlink. Signed-off-by: Jiwen Cai <jiwenc@nvidia.com>
1 parent db49f84 commit 3189544

5 files changed

Lines changed: 4 additions & 5 deletions

File tree

docs/source/conf.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -144,7 +144,7 @@
144144

145145
def _parse_code_role(text):
146146
"""Parse role text as 'path' or 'label <path>'. Returns (label, path)."""
147-
text = text.strip()
147+
text = " ".join(text.split()) # collapse newlines from source line wrapping
148148
if " <" in text and text.endswith(">"):
149149
label, path = text.rsplit(" <", 1)
150150
return label.strip(), path[:-1].strip()

docs/source/getting_started/build_from_source/index.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -142,7 +142,7 @@ Useful targets:
142142
Other Build options
143143
~~~~~~~~~~~~~~~~~~~
144144

145-
The CMake options (defined in root :code-file:`CMakeLists.txt`, :code-file:`cmake/SetupPython.cmake`, and :code-file:`cmake/SetupHunter.cmake`):
145+
The CMake options (defined in root :code-file:`CMakeLists.txt` and :code-file:`cmake/SetupPython.cmake`):
146146

147147
.. list-table:: Common CMake Options
148148
:widths: 20 36 44

docs/source/getting_started/teleop_session.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ Overview
1414

1515
The main component is :code-file:`TeleopSession <src/core/teleop_session_manager/python/teleop_session.py>`, which manages the complete lifecycle
1616
of a teleop session. It wraps the lower-level
17-
:code-file:`DeviceIOSession <src/core/deviceio/cpp/inc/deviceio/deviceio_session.hpp>`
17+
:code-file:`DeviceIOSession <src/core/deviceio_session/cpp/inc/deviceio_session/deviceio_session.hpp>`
1818
and :doc:`device trackers <../device/trackers>` so that callers don't need to
1919
manage them directly:
2020

docs/source/index.rst

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -87,5 +87,4 @@ Indices and tables
8787
------------------
8888

8989
* :ref:`genindex`
90-
* :ref:`modindex`
9190
* :ref:`search`

docs/source/references/mcap_record_replay.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -161,7 +161,7 @@ Replay runs headless — no headset required:
161161
uv run python replay_hand.py --loop # repeat until Ctrl+C
162162
uv run python replay_hand.py --port 8090 # change viser port
163163
164-
Open the printed URL (default http://localhost:8080) in a browser to see the
164+
Open the printed URL (default ``http://localhost:8080``) in a browser to see the
165165
left (green) and right (blue) hand skeletons update each frame.
166166

167167
The ``record_controller.py`` / ``replay_controller.py`` and

0 commit comments

Comments
 (0)