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

Add video MIME types to Documenter.display_dict #2552

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

asinghvi17
Copy link
Contributor

Following from what was discussed on the community call a couple of months ago. Still WIP and I will have to test locally.

@mortenpi
Copy link
Member

mortenpi commented Aug 7, 2024

Two thoughts here:

  1. So we do this thing where we show every available MIME type. I'm a little concerned that we might end up unintentionally rendering heaps of videos in some doc suddenly, which I think can be quite expensive. So I wonder if we'd want this to be per-block opt-in? Maybe the concern is a bit unfounded though -- how common are the video show methods?

  2. I wonder if we could add something really simple to the Showcase page? I guess we'd have to commit a tiny video file into the repository for that, unless we could somehow generate it.

@fredrikekre
Copy link
Member

For 1. I think it only becomes a problem if an object support all of the video formats and all three are rendered but perhaps this is common? Or is there generally just one implemented?

As a side note, some people complain about slow build times because of the display_dict so perhaps the mimes should somehow be filtered keeping in mind that not all options may end up being used.

@mortenpi
Copy link
Member

mortenpi commented Aug 7, 2024

For 1. I think it only becomes a problem if an object support all of the video formats and all three are rendered but perhaps this is common? Or is there generally just one implemented?

Rendering multiple videos is actually something I didn't even consider, but I agree, this is also something we should think about.

My concern was mostly about existing docs with many complex figures now potentially rendering heaps of videos though.

As a side note, some people complain about slow build times because of the display_dict so perhaps the mimes should somehow be filtered keeping in mind that not all options may end up being used.

I'm not sure how we should approach this, but doing something about that wouldn't hurt, I agree.

@fredrikekre
Copy link
Member

My concern was mostly about existing docs with many complex figures now potentially rendering heaps of videos though.

But are there objects which have both a video representation and image representations? I would expect it to be mutually exclusive?

@mortenpi
Copy link
Member

mortenpi commented Aug 7, 2024

But are there objects which have both a video representation and image representations?

I wouldn't be surprised if animations would fall back to the first frame maybe? But whether that's actually common, I don't know.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants