Skip to content

Social card links can be broken in multiversioned documentations #103

@illia-v

Description

@illia-v

urllib3 has recently started relying on sphinxext-opengraph. In urllib3/urllib3#3064 I tried setting up social cards, but ended up facing problems related to canonical URLs in Read the Docs.

urllib3 has docs for multiple versions of the package and for every new pull request.

sphinxext-opengraph seems to always start URLs of the cards with https://urllib3.readthedocs.io/en/stable/ regardless of the docs version (for example, at https://urllib3--3064.org.readthedocs.build/en/3064/.)

This leads to a problem that a score card linked in og:image is not available in any docs version until it is deployed to "stable".

But even after it is deployed there, there is a high chance that og:image in other versions will lead to a nonexistent image because of the hash in the filename affected by multiple details of a page.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions