Skip to content

Custom tags and EPUB builder #136

@m-aciek

Description

@m-aciek

Recently CPython's conf.py replaced self-closing tags with simpler, HTML5 ones. It broke EPUB builds as those are not XHTML-compatible.

Could sphinxext-opengraph rewrite custom meta tags to self-closing for EPUB builder?

Alternatives: (1) could sphinxext-opengraph disable custom meta tags for EPUB builder (or allow it through config)? Or: (2) could sphinxext-opengraph disable adding all tags to the layout for EPUB builder (or allow disabling it for EPUB builder through config)?

Activity

AA-Turner

AA-Turner commented on May 15, 2025

@AA-Turner
Member

PR welcome

linked a pull request that will close this issue on May 16, 2025
m-aciek

m-aciek commented on Jul 10, 2025

@m-aciek
Author

In the meantime we started to skip custom tags for EPUB builds in CPython docs. Though og:description and < character inside it is causing failures for 8 (random) chapters. Would it be possible to merge #137?

@AA-Turner if you'd use some help with maintenance, could you possibly grant @TheTripleV with the permissions to merge and/or release?

PS, update: It looks like escaping HTML should work as well (render correct previews).

PPS, update: it looks like escaping HTML won't work. update: I've corrected the (1st) PS adding a link

AA-Turner

AA-Turner commented on Jul 10, 2025

@AA-Turner
Member

It looks like Vasista should have merge permissions:

Image
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

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

      Development

      Participants

      @AA-Turner@m-aciek

      Issue actions

        Custom tags and EPUB builder · Issue #136 · sphinx-doc/sphinxext-opengraph