Add full support for image, video and audio tags. #60
Conversation
| return urljoin(url, image_path) | ||
|
|
||
|
|
||
| def note_image(image_path: str, docname: str, app: Sphinx): |
There was a problem hiding this comment.
Open for comments on any of the matters mentioned in the comments in this function
| if "og:image" in fields: | ||
| image_url = fields["og:image"] | ||
| ogp_use_first_image = False | ||
| ogp_image_alt = fields.get("og:image:alt") | ||
| fields.pop("og:image", None) | ||
| image_url = image_abs_url( | ||
| fields.pop("og:image"), config["ogp_site_url"], docname, app | ||
| ) | ||
| image_alt = fields.pop("og:image:alt", None) | ||
| elif fields.get("ogp_use_first_image", config["ogp_use_first_image"]) and ( | ||
| first_image := doctree.next_node(nodes.image) | ||
| ): | ||
| # Use page url, since the image uri at this point is relative to the output page | ||
| image_url = image_abs_url(first_image["uri"], page_url) | ||
| image_alt = first_image.get("alt", fields.pop("og:image:alt", None)) | ||
| else: | ||
| image_url = config["ogp_image"] | ||
| ogp_use_first_image = config["ogp_use_first_image"] | ||
| ogp_image_alt = fields.get("og:image:alt", config["ogp_image_alt"]) | ||
|
|
||
| fields.pop("og:image:alt", None) | ||
|
|
||
| if ogp_use_first_image: | ||
| first_image = doctree.next_node(nodes.image) | ||
| if ( | ||
| first_image | ||
| and Path(first_image.get("uri", "")).suffix[1:].lower() in IMAGE_MIME_TYPES | ||
| ): | ||
| image_url = first_image["uri"] | ||
| ogp_image_alt = first_image.get("alt", None) | ||
| # | ||
| image_url = image_abs_url( | ||
| config["ogp_image"], config["ogp_site_url"], docname, app | ||
| ) | ||
| image_alt = config["ogp_image_alt"] |
There was a problem hiding this comment.
Open for comments on this implementation I have a few ideas but still would like to hear anything else, currently uses walrus operator (would like to avoid that if possible, since currently, we support down to 3.6)
| image_url = first_image["uri"] | ||
| ogp_image_alt = first_image.get("alt", None) | ||
| # | ||
| image_url = image_abs_url( |
There was a problem hiding this comment.
Optionally, we could rework this so that if a relative path is specified in ogp_image (i.e, path doesn't start with a slash), then we will assume that every document contains an image to be used for the metadata of that document. (So if ogp_image would be ../images/og.png, a site could have a easier time setting a separate image for each document)
|
Is this PR stale? |
Closes #53.
Adds full support for image, video, and audio og tags:
Currently, whether an image is configured in
conf.pyor in field lists, if it starts with/it is treated as relative to the root, if it doesn't it's treated relative to the current document. I think this functionality is fine and allows you to set up different images for each file without field lists if you use the same naming scheme (i.e. `images/docname/opengraph.png). but open to comments.