docs/ci: Renode driver listing and conditional macOS Renode install

[mangelajo]

Summary

Documentation

• Register Renode (jumpstarter-driver-renode) in the drivers reference index and the hidden toctree, so renode.md (symlinked from the package README) is part of the Sphinx tree and the “document isn’t included in any toctree” warning goes away.
• Remove the Design Decisions paragraph that pointed at the old ADR path (contributing/adr/0001-renode-integration.md), which no longer exists and caused MyST xref failures under make docs (-W).

No change to the in-repo JEP under docs/internal/jeps/; we can add a link again once the team agrees on how to reference it from published docs.

CI (Python Tests workflow)

• macOS: brew install renode/tap/renode is slow (~5+ minutes per job). It now runs only when the change set touches python/packages/jumpstarter-driver-renode/** (via paths-filter), or on workflow_dispatch so manual runs still get full coverage.
• Linux: unchanged; the .deb install remains for every matrix job (fast).

Testing

• make docs (from python/)

[coderabbitai]

📝 Walkthrough

Walkthrough

The pull request adds Renode to the drivers documentation index as a "Debug and Programming" driver package, including both a documentation entry and toctree reference. Simultaneously, it removes a reference to ADR-0001 from the Renode driver package's README file.

Changes

Cohort / File(s)	Summary
Documentation Index python/docs/source/reference/package-apis/drivers/index.md	Added Renode as a new "Debug and Programming" driver package with link to renode.md and package name jumpstarter-driver-renode. Updated hidden toctree to include renode.md for navigation discoverability.
Package README python/packages/jumpstarter-driver-renode/README.md	Removed reference to ADR-0001 file from the "Design Decisions" section.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Possibly related PRs

• Add Renode emulator driver for embedded target simulation #533: Introduces the Renode driver implementation; this PR adds the corresponding documentation entry and cleans up related README content.

Suggested reviewers

• raballew

Poem

🐰 A rabbit hops through docs with glee,
Renode joins the driver family tree,
New entries spring forth, clean and bright,
Documentation polished just right! ✨

🚥 Pre-merge checks | ✅ 3

✅ Passed checks (3 passed)

Check name	Status	Explanation
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Title check	✅ Passed	The title partially relates to the changeset—it mentions 'Renode driver listing' which matches the documentation changes, but 'conditional macOS Renode install' refers to CI changes not fully visible in the provided summaries and may be secondary to the main documentation fix.
Description check	✅ Passed	The description is directly related to the changeset, clearly explaining the documentation registration of the Renode driver, removal of broken ADR references, and CI optimizations for macOS Renode installation.

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

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Create PR with unit tests

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

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

[mangelajo]

the doc is in the internal directory and can't be grabbed by sphinx

[coderabbitai]

🧹 Nitpick comments (1)

python/docs/source/reference/package-apis/drivers/index.md (1)

116-159: Consider alphabetical ordering in the toctree (optional).

The hidden toctree entries are not consistently alphabetically ordered. For example, gpiod.md appears after renode.md when it should come earlier alphabetically. While this doesn't affect functionality, maintaining alphabetical order improves maintainability and makes it easier to spot missing entries.

This is a pre-existing organizational inconsistency and not introduced by this PR, so it could be addressed in a separate cleanup if desired.

🤖 Prompt for AI Agents

Verify each finding against the current code and only fix it if needed.

In `@python/docs/source/reference/package-apis/drivers/index.md` around lines 116
- 159, Reorder the hidden toctree entries in the drivers index so they are
alphabetically sorted (e.g., move gpiod.md to appear before renode.md); edit the
toctree block containing the listed filenames (adb.md, androidemulator.md, ...,
yepkit.md) and sort all filenames lexicographically to ensure consistent
maintainability.

🤖 Prompt for all review comments with AI agents

Verify each finding against the current code and only fix it if needed.

Nitpick comments:
In `@python/docs/source/reference/package-apis/drivers/index.md`:
- Around line 116-159: Reorder the hidden toctree entries in the drivers index
so they are alphabetically sorted (e.g., move gpiod.md to appear before
renode.md); edit the toctree block containing the listed filenames (adb.md,
androidemulator.md, ..., yepkit.md) and sort all filenames lexicographically to
ensure consistent maintainability.

---

ℹ️ Review info

⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: b4099c0d-9c91-42f9-9637-f85bdca152f5

📥 Commits

Reviewing files that changed from the base of the PR and between e8e9731 and 2600a42.

📒 Files selected for processing (2)

• python/docs/source/reference/package-apis/drivers/index.md
• python/packages/jumpstarter-driver-renode/README.md

💤 Files with no reviewable changes (1)

• python/packages/jumpstarter-driver-renode/README.md