Skip to content

gcp-sphinx-docfx-yaml: patch_docfields is inactive #19085

Open

Description

@daniel-sanche

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

Activity

  1. added
    type: bugError or flaw in code with unintended results or allowing sub-optimal usage patterns.
    triage meI really want to be triaged.
    on Nov 14, 2026
  2. 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
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    triage meI really want to be triaged.type: bugError or flaw in code with unintended results or allowing sub-optimal usage patterns.

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions