Problem
The live generated Python API reference renders Sphinx cross-reference roles literally. The Client page shows text such as :class:Client and `:class:`~durable_workflow.Worker in customer-facing prose, and the SDK source contains the same :class:, :meth:, :func:, :attr:, :mod:, and :exc: forms across multiple public modules. This makes the generated reference look unfinished and obscures intended symbol relationships on a primary destination from the SDK landing page.
Acceptance criteria
- Make the generated API pipeline render supported docstring cross-references as clean symbol text and links where the target can be resolved.
- Remove visible raw role markers from generated public module and member prose without freezing ordinary wording.
- Add a focused rendered-output check that detects leaked cross-reference syntax across representative generated pages.
- Visually qualify the Client page and at least one other affected generated page at desktop, intermediate, mobile, and short-height sizes.
Delete when the deployed generated reference no longer exposes raw docstring role syntax and the rendered-output gate prevents recurrence.
Problem
The live generated Python API reference renders Sphinx cross-reference roles literally. The Client page shows text such as
:class:Clientand `:class:`~durable_workflow.Workerin customer-facing prose, and the SDK source contains the same:class:,:meth:,:func:,:attr:,:mod:, and:exc:forms across multiple public modules. This makes the generated reference look unfinished and obscures intended symbol relationships on a primary destination from the SDK landing page.Acceptance criteria
Delete when the deployed generated reference no longer exposes raw docstring role syntax and the rendered-output gate prevents recurrence.