Fix docs build: update Triton/Gluon mocks in conf.py#382
Conversation
Co-authored-by: mawad-amd <112003944+mawad-amd@users.noreply.github.com>
|
@copilot did you verify the generated documentation? |
There was a problem hiding this comment.
Pull request overview
This PR fixes a critical documentation build issue where Sphinx autodoc was silently failing to import all iris.* modules, resulting in empty API reference pages. The root cause was missing constexpr_function attribute in the Triton and Gluon mock classes used during documentation generation, which caused import failures when importing modules that use this decorator.
Changes:
- Added
constexpr_function = PreserveDocstringMock()to bothTritonMockandGluonMockclasses to handle the@triton.constexpr_functionand@gluon.constexpr_functiondecorators used in aggregate class constructors - Enhanced
PreserveDocstringMock.__call__()to handle both direct decorator (@triton.jit) and decorator factory (@triton.jit()) usage patterns - Added
"tritonblas"toautodoc_mock_importslist since it's imported byiris.opsmodules but unavailable in the docs build environment
Yes — I built the docs locally using the same
Zero |

Sphinx autodoc was silently failing to import all
iris.*modules, producing empty API reference pages. The root cause:TritonMockandGluonMockindocs/conf.pywere missingconstexpr_function, which is used as a decorator iniris/tracing/events.pyandiris/experimental/iris_gluon.py.Changes
TritonMock/GluonMock: Addconstexpr_function = PreserveDocstringMock()to both mock classesPreserveDocstringMock: Handle decorator factory pattern (@triton.jit()with empty parens) in addition to the direct form (@triton.jit) — used extensively iniris/ops/andiris/x/autodoc_mock_imports: Add"tritonblas"—iris.opsimports from it and it's unavailable in the docs build environmentThe import failure chain:
iris/__init__.py→iris/iris.py→iris/tracing/__init__.py→iris/tracing/events.py→@triton.constexpr_function→AttributeError→ all autodoc directives fail silently.Original prompt
💬 We'd love your input! Share your thoughts on Copilot coding agent in our 2 minute survey.