Commit 8e330c7
[Docs] Add MAX Python API documentation coverage check
Adds a deterministic GitHub Action that detects when a PR adds or
removes
public symbols from `max/python/max/` without a corresponding update
under
`max/python/docs/`, and upserts a sticky PR comment listing the
candidate
RST locations and tagging `@modularml/docs`.
The check runs `max/python/docs/check_api_coverage.py`, which compares
the
public surface (parsed from `__all__` and PEP 484 `from X import Y as Y`
re-exports) at the PR base against the head, then matches each
added/removed symbol against autosummary entries and `automodule
:members:`
expansions in the docs tree. The comment lists three categories:
* New public symbols missing from `max/python/docs/`
* Symbols removed from `__all__` but still referenced in RST
* Newly imported in an `__init__.py` but not in `__all__` (the
DeviceStream / DOCS-1117 pattern — possibly a missed export)
The check is advisory and does not block merge.
MODULAR_ORIG_COMMIT_REV_ID: 784d5a08e22b927d72d2ef76830c877846db17cf1 parent 8a0d8ef commit 8e330c7
1 file changed
Lines changed: 703 additions & 0 deletions
0 commit comments