API Documentation for nvtripy

When to Use

• Writing or updating docstrings for public API functions, classes, or modules
• Adding working code examples to documentation
• Choosing the correct document_under path for @export.public_api
• Understanding how documentation is generated and built

Documentation Pipeline

1. @export.public_api(document_under="...") registers APIs in PUBLIC_APIS list
2. docs/generate_rsts.py reads PUBLIC_APIS and generates .rst files in the docs hierarchy
3. Sphinx builds the final HTML docs from those .rst files
4. Docstring code examples are extracted and validated during testing

@export.public_api Parameters