You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
Repository navigation
gcp-sphinx-docfx-yaml: patch_docfields is inactive #19085
docfx_yaml/monkeypatch.py is meant to transform some sphinx fields to re-format links to markdown, etc. But on our pinned sphinx==4.5.0 the patch never takes effect.
I tried to update to Sphinx 7 and re-enable it, but it lead to more bugs in the output than it resolved (including exceptions when building docs for some packages)
We should look into this more, and decide whether it's worth re-enabling, or keeping off
changed the title [-]gcp-sphinx-docfx-yaml: patch_docfields is silently inactive on Sphinx < 4 and breaks output and builds on Sphinx >= 5[/-][+]gcp-sphinx-docfx-yaml: patch_docfields is inactive[/+]on Nov 14, 2026
Hi! I'd like to work on this issue as my first contribution to the Google Cloud Python libraries.
I've reviewed the problem with patch_docfields and would like to investigate the Sphinx compatibility issue, add an appropriate regression test, and submit a focused fix.
Is this issue still available for contribution? Would you be happy to review a PR addressing this?
Activity
[-]gcp-sphinx-docfx-yaml: patch_docfields is silently inactive on Sphinx < 4 and breaks output and builds on Sphinx >= 5[/-][+]gcp-sphinx-docfx-yaml: patch_docfields is inactive[/+]MTA2931 commentedon Nov 19, 2026
Hi! I'd like to work on this issue as my first contribution to the Google Cloud Python libraries.
I've reviewed the problem with
patch_docfieldsand would like to investigate the Sphinx compatibility issue, add an appropriate regression test, and submit a focused fix.Is this issue still available for contribution? Would you be happy to review a PR addressing this?