Commit 4413a5c
authored
[DOC] Add extension APIs to runtime API reference (#19385)
Fixes #19348
### Summary
- Add `extension/module` and `extension/tensor` headers to the Doxygen
inputs used by the runtime API reference.
- Expand the module namespace macros so Breathe can resolve the
documented extension classes with stable namespace names.
- Add runtime API reference sections for `Module`, `BundledModule`, and
the tensor extension namespace.
### Test plan
- `git diff --check origin/main..HEAD`
- `python -m py_compile docs/source/conf.py`
- `cd docs && doxygen source/Doxyfile`
- Isolated Breathe/Sphinx build of
`executorch-runtime-api-reference.rst` against the generated Doxygen XML
- Verified the rendered runtime API page contains the new Module
Extension and Tensor Extension entries
cc @mergennachin @AlannaBurke1 parent 9e4e497 commit 4413a5c
2 files changed
Lines changed: 32 additions & 3 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
963 | 963 | | |
964 | 964 | | |
965 | 965 | | |
| 966 | + | |
| 967 | + | |
| 968 | + | |
| 969 | + | |
| 970 | + | |
966 | 971 | | |
967 | 972 | | |
968 | 973 | | |
| |||
2374 | 2379 | | |
2375 | 2380 | | |
2376 | 2381 | | |
2377 | | - | |
| 2382 | + | |
2378 | 2383 | | |
2379 | 2384 | | |
2380 | 2385 | | |
2381 | 2386 | | |
2382 | 2387 | | |
2383 | 2388 | | |
2384 | 2389 | | |
2385 | | - | |
| 2390 | + | |
2386 | 2391 | | |
2387 | 2392 | | |
2388 | 2393 | | |
| |||
2415 | 2420 | | |
2416 | 2421 | | |
2417 | 2422 | | |
2418 | | - | |
| 2423 | + | |
| 2424 | + | |
2419 | 2425 | | |
2420 | 2426 | | |
2421 | 2427 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
40 | 40 | | |
41 | 41 | | |
42 | 42 | | |
| 43 | + | |
| 44 | + | |
| 45 | + | |
| 46 | + | |
| 47 | + | |
| 48 | + | |
| 49 | + | |
| 50 | + | |
| 51 | + | |
| 52 | + | |
| 53 | + | |
| 54 | + | |
| 55 | + | |
| 56 | + | |
| 57 | + | |
| 58 | + | |
| 59 | + | |
| 60 | + | |
| 61 | + | |
| 62 | + | |
| 63 | + | |
| 64 | + | |
| 65 | + | |
0 commit comments