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

Convert cross references properly for code content #331

Open dandhlee opened 1 year ago

dandhlee commented 1 year ago

Currently cross references are only converted to xref tags and are not usable within code content. For example:

>>> import <xref uid="bigframes.pandas">bigframes.pandas</xref> as bpd
>>> bpd.options.display.progress_bar = None

We'll need to find direct links, however should be possible. See go examples: https://cloud.google.com/go/docs/reference/cloud.google.com/go/alloydb/latest/apiv1#cloud_google_com_go_alloydb_apiv1_DefaultAuthScopes