Embed audio samples in generated tutorials #1985
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
It turned out that generated tutorials can embed the audio if the following conditions are met. This commit changes how audio samples are shown in tutorials so that they become playable in doc. 1. There is only one `IPython.display.Audio` call in a cell 2. `IPython.display.Audio` is the last function called in the cell 3. Audio format is `wav` (`flac` can be contained, but browsers (Chrome/Safari) won't play it) Ref: https://stackoverflow.com/a/33109647
mthrok
changed the title
hwangjeff
approved these changes
Nov 5, 2021
carolineechen
approved these changes
Nov 5, 2021
mthrok
added a commit
to mthrok/audio
that referenced
this pull request
Dec 3, 2021
It turned out that generated tutorials can embed the audio if the following conditions are met. This commit changes how audio samples are shown in tutorials so that they become playable in doc. 1. There is only one `IPython.display.Audio` call in a cell 2. An object of `IPython.display.Audio` is the last object interpreter receives in the cell 3. Audio format is `wav` (`flac` can be embedded as well, but browsers (Chrome/Safari) won't play it) Ref: https://stackoverflow.com/a/33109647
mthrok
added a commit
to mthrok/audio
that referenced
this pull request
Dec 3, 2021
It turned out that generated tutorials can embed the audio if the following conditions are met. This commit changes how audio samples are shown in tutorials so that they become playable in doc. 1. There is only one `IPython.display.Audio` call in a cell 2. An object of `IPython.display.Audio` is the last object interpreter receives in the cell 3. Audio format is `wav` (`flac` can be embedded as well, but browsers (Chrome/Safari) won't play it) Ref: https://stackoverflow.com/a/33109647
mthrok
pushed a commit
to mthrok/audio
that referenced
this pull request
Dec 13, 2022
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
It turned out that generated tutorials can embed the audio if the following conditions are met.
This commit changes how audio samples are shown in tutorials so that they become playable in doc.
IPython.display.Audiocall in a cellIPython.display.Audiois the last function called in the cellwav(
flaccan be embedded as well, but browsers (Chrome/Safari) won't play it)Ref: https://stackoverflow.com/a/33109647
Before
After
