googleapis / sphinx-docfx-yaml

Forked sphinx-docfx-yaml repository for creating DocFX YAML for Python Client Libraries
Apache License 2.0
5 stars 7 forks source link

fix: ignore cross reference conversion in examples #332

Closed dandhlee closed 1 year ago

dandhlee commented 1 year ago

Bigframes team saw that cross references were converting their example code content, see https://cloud.google.com/python/docs/reference/bigframes/latest/bigframes.session.Session#bigframes_session_Session_read_gbq. The conversion for cross references don't work in code content, temporarily fixing this for Bigframes team's example.

I've filed #331 to follow up to ensure that code content gets properly converted into links. Until then, for example content found in the summary, they won't get converted into xrefs.

Fixes b/306420925.