adding-doc-snippets
Installation
SKILL.md
Adding Doc Snippets
Overview
Every substantial code example in the ovrtx docs must be backed by a tested snippet. This skill walks through the full workflow from writing the test to wiring up the RST.
Step 1: Decide where the test goes
| Code type | Test file location | Why |
|---|---|---|
| ovrtx Python API | tests/docs/python/test_<doc_page>.py |
Needs ovrtx package, GPU to run |
| USDA examples | tests/docs/usd/data/<name>.usda (data) + tests/docs/usd/test_*_usda.py (validation) |
Needs usd-core to validate |
| USD Python API | tests/docs/usd/test_usd_python_examples.py |
Needs usd-core, no GPU |
| ovrtx C API | tests/docs/c/test_<doc_page>.cpp |
Needs ovrtx C API, CMake, GoogleTest, GPU |
Keep usd-core imports in tests/docs/usd/ unless a snippet explicitly needs to demonstrate OpenUSD interop with ovrtx; this keeps the ovrtx runtime tests from picking up docs-only USD dependencies.