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

fix: make build parralel friendly #15

Merged
merged 1 commit into from
Feb 21, 2023
Merged

fix: make build parralel friendly #15

merged 1 commit into from
Feb 21, 2023

Conversation

12rambau
Copy link
Member

superceed #10

@12rambau 12rambau marked this pull request as ready for review February 21, 2023 13:10
@12rambau 12rambau changed the base branch from parralel to master February 21, 2023 13:10
@12rambau 12rambau merged commit c08d620 into sphinx-contrib:master Feb 21, 2023
@12rambau 12rambau deleted the parralel branch February 21, 2023 13:12
@12rambau 12rambau mentioned this pull request Feb 21, 2023
@benjaoming
Copy link

This didn't include the parts from #10 that skips adding videos to irrelevant formats? Was that on purpose?

        latex=ignore_node,
        text=ignore_node,
        man=ignore_node,
        texifo=ignore_node,

@benjaoming
Copy link

Ah, it's in #16 👍

@12rambau
Copy link
Member Author

I'm going to use squash merges from now so I try to split things up

@benjaoming
Copy link

All good 👍

Looking forwards to the release! I did this write-up while trying to figure out how on earth to quickly put instruction videos in documentation: https://github.com/benjaoming/anti-pattern-sphinx-video-downloader

Would be curious if you have considered various approaches and what you think is the best way forward for documentation projects in general?

Are you going to put the documentation up on RTD? :)

@12rambau
Copy link
Member Author

12rambau commented Feb 21, 2023

TBH the youtube solution in combination with sphinxcontrib-youtube works quite well for huge videos. Note that github LFS is not supported in RDT (last time I checked). Note that Drive videos behave the same as a youtube video and ca thus be wired the same way.

On the other hand, for smaller one that you can afford to host in your docs (a 1 min demo of the product/tool) sphinxcontrib-video should do the trick.

@benjaoming
Copy link

Git LFS is supported on RTD by extending the build process: https://docs.readthedocs.io/en/stable/build-customization.html#support-git-lfs-large-file-storage

@12rambau
Copy link
Member Author

that's perfect, it seems I'm confusing with another service ;-)

@benjaoming
Copy link

benjaoming commented Feb 22, 2023

I'm not so clear in the description on https://github.com/benjaoming/anti-pattern-sphinx-video-downloader, but I suggest basically to have 2 repos active for documentation with video:

  1. Repo for the documentation: Because it's documentation, it changes often and is built often, so we don't want large files here. During builds, we download videos from repo 2 (and can store them in a local cache if possible).

  2. Repo/resource for videos: Here, we store and publish the videos. This can be both Git and Google Drive, depending on what level of archive history that you need.

Note: The name of the video could be versioned such that old documentation can keep the original videos that they were published with.

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

Successfully merging this pull request may close these issues.

2 participants