[CLIENT-4425] Docs: fix invalid cross references (unrelated to type aliases)#1024

Merged

juliannguyen4 merged 21 commits intodevfrom

CLIENT-4425-doc-only-fix-broken-cross-references-without-dealing-with-type-alias-errors-or-sphinx-autodoc-typehints

Apr 13, 2026

Commits on Apr 13, 2026

Cherrypick changes from CLIENT-4425-docs-fix-broken-internal-references unrelated to type aliases. Those are harder to fix so delay until after next client release
juliannguyen4
committed
Ignore all warnings related to type aliases for now
juliannguyen4
committed
Currently getting a parser error. I suspect the first * is causing it.
juliannguyen4
committed
Regex looks wrong
juliannguyen4
committed
Fix remaining errors, 2 of them I forgot to cherrypick. The optional syntax is valid for google docstrings, but follow the example by adding obj
juliannguyen4
committed
Fix
juliannguyen4
committed
Fix invalid type hint. any with lowercase refers to a built in method, not the type
juliannguyen4
committed
TypeExpression evaluates to a confusing value in the rendered docs. Add a docstring to make this method less confusing
juliannguyen4
committed
Since there is no cross reference available for TypeExpression, maybe making it private is better. It shouldn't be evaluated in the public API b/c it is an implementation detail.
juliannguyen4
committed
Document TypeExpression in attempt to make Sphinx not expand it in _BaseExpr.compile()
juliannguyen4
committed
Revert
juliannguyen4
committed
Follow the sphinx autodoc docs to prevent sphinx from expanding this type alias
juliannguyen4
committed
Make sure Python interpreter doesn't evaluate type aliases at runtime here. Otherwise, I guess it gets evaluated before Sphinx autodoc can parse it.
juliannguyen4
committed
Since TypeExpression is referenced by cdt_ctx_all_children*, add a docstring to be more clear
juliannguyen4
committed
Docstring still not showing up. Maybe a space needed?
juliannguyen4
committed
Still doesn't work. Try this
juliannguyen4
committed
typing.Callable looks too verbose in the rst code. Try seeing if Python will generate a reference for Callable alone using intersphinx
juliannguyen4
committed
Revert "typing.Callable looks too verbose in the rst code. Try seeing if Python will generate a reference for Callable alone using intersphinx"
juliannguyen4
committed
TypeExpression cross ref now works, so add these back.
juliannguyen4
committed
Add back TypeExpression
juliannguyen4
committed
use better syntax
juliannguyen4
committed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[CLIENT-4425] Docs: fix invalid cross references (unrelated to type aliases)#1024

[CLIENT-4425] Docs: fix invalid cross references (unrelated to type aliases)#1024
juliannguyen4 merged 21 commits intodevfrom
CLIENT-4425-doc-only-fix-broken-cross-references-without-dealing-with-type-alias-errors-or-sphinx-autodoc-typehints

Commits on Apr 13, 2026

Cherrypick changes from CLIENT-4425-docs-fix-broken-internal-references unrelated to type aliases. Those are harder to fix so delay until after next client release

Ignore all warnings related to type aliases for now

Currently getting a parser error. I suspect the first * is causing it.

Regex looks wrong

Fix remaining errors, 2 of them I forgot to cherrypick. The optional syntax is valid for google docstrings, but follow the example by adding obj

Fix

Fix invalid type hint. any with lowercase refers to a built in method, not the type

TypeExpression evaluates to a confusing value in the rendered docs. Add a docstring to make this method less confusing

Since there is no cross reference available for TypeExpression, maybe making it private is better. It shouldn't be evaluated in the public API b/c it is an implementation detail.

Document TypeExpression in attempt to make Sphinx not expand it in _BaseExpr.compile()

Revert

Follow the sphinx autodoc docs to prevent sphinx from expanding this type alias

Make sure Python interpreter doesn't evaluate type aliases at runtime here. Otherwise, I guess it gets evaluated before Sphinx autodoc can parse it.

Since TypeExpression is referenced by cdt_ctx_all_children*, add a docstring to be more clear

Docstring still not showing up. Maybe a space needed?

Still doesn't work. Try this

typing.Callable looks too verbose in the rst code. Try seeing if Python will generate a reference for Callable alone using intersphinx

Revert "typing.Callable looks too verbose in the rst code. Try seeing if Python will generate a reference for Callable alone using intersphinx"

TypeExpression cross ref now works, so add these back.

Add back TypeExpression

use better syntax