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

Added thematic guide for the manim-voiceover plugin #3049

Merged
merged 2 commits into from Dec 1, 2022

Conversation

osolmaz
Copy link
Contributor

@osolmaz osolmaz commented Nov 29, 2022

Overview: What does this pull request change?

This adds a small section in the docs about using Manim Voiceover to add voiceovers to videos.

Motivation and Explanation: Why and how do your changes improve the library?

Docs are the main resource for learning Manim. It would be nice if people get to know about Manim Voiceover while using it, because it solves a major pain point while developing Manim animations

Links to added or changed documentation pages

https://manimce--3049.org.readthedocs.build/en/3049/guides/add_voiceovers.html

Further Information and Comments

I added a new page under Thematic Guides. Feel free to propose something else.

Also, I refrained from including a video and just linked the examples gallery https://voiceover.manim.community/en/latest/examples.html
Getting an example video included in the build is not viable, because it both requires committing mp3 files to the repo and installing a plugin in the build container.
If you think a video would be nice, I could link one of the GitHub hosted videos like I do in Manim Voiceover docs.

Reviewer Checklist

  • The PR title is descriptive enough for the changelog, and the PR is labeled correctly
  • If applicable: newly added non-private functions and classes have a docstring including a short summary and a PARAMETERS section
  • If applicable: newly added functions and classes are tested

Copy link
Member

@behackl behackl left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is a nice addition, thank you! You could also have written the tutorial as a markdown file, but now that it is already ReST (and is formatted correctly, as far as I can tell), it doesn't make sense to change it either.

Perhaps anyone who has used manim-voiceover before a bit more wants to chime in and comment on this PR, but from my point of view it is fine to include the tutorial like this.

I've left one (non-blocking) comment, please take a look.

docs/source/guides/add_voiceovers.rst Outdated Show resolved Hide resolved
@behackl behackl added the documentation Improvements or additions to documentation label Nov 30, 2022
Co-authored-by: Benjamin Hackl <devel@benjamin-hackl.at>
@behackl behackl changed the title Added page explaining manim voiceover Added thematic guide for the manim-voiceover plugin Nov 30, 2022
@behackl behackl added the highlight For contributions that should be highlighted explicitly in the next changelog label Dec 1, 2022
@behackl behackl merged commit 621f829 into ManimCommunity:main Dec 1, 2022
@osolmaz osolmaz deleted the add-manim-voiceover-to-docs branch December 2, 2022 00:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation highlight For contributions that should be highlighted explicitly in the next changelog
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants