Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

missing opengraph/oembed attributes in docs pages? #469

Open
jni opened this issue Jul 29, 2024 · 2 comments
Open

missing opengraph/oembed attributes in docs pages? #469

jni opened this issue Jul 29, 2024 · 2 comments
Labels
bug Something isn't working

Comments

@jni
Copy link
Member

jni commented Jul 29, 2024

🐛 Bug

When I add a link to the API documentation in Discourse, the link preview gives me this warning:

https://napari.org/stable/api/napari.components.LayerList.html#napari.components.LayerList

Screenshot of a framed webpage preview, showing the page title followed by the text: 'Sorry, we were unable to generate a preview for this web page, because the following oEmbed / OpenGraph tags could not be found: description, image'.

I actually find the Discourse link previews a little obnoxious 😂 but I prefer to disable them manually than to accidentally disable them by not using the correct standards for things. 😂

I don't know what OpenGraph or oEmbed mean but if they are standard things expected of any webpage then we should figure out how to enable them on the API docs.

@jni jni added the bug Something isn't working label Jul 29, 2024
@melissawm
Copy link
Member

This is a weird one... I thought this was automatically done. Maybe there's a sphinx/theme setting for it?

@jni
Copy link
Member Author

jni commented Jul 29, 2024

Yeah. Note that I don't consider investigating this a high priority — just wanted to note it down in case it's trivial and/or someone has time to devote to it.

@melissawm melissawm moved this from Prioritized to Backlog in Documentation Working Group Jul 29, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
Development

No branches or pull requests

2 participants