Embed terminal videos in documentation

[kai-tub]

Hi all.

First of all, I would like to thank everyone that has been involved in creating this awesome library!
It definitely has created a renaissance of terminal/CLI applications. 👍

I would like to contribute to the rich project and more specifically to the documentation.
With rich in mind, I have written the Sphinx CLI Recorder extension.
I find rich produces beautiful outputs but the documentation does not include many visual examples.
I know that this will probably change in the very near future with recent SVG export functionality. 😉

Though the SVG exporter will make it easy to include example output pictures, I think there is still some validity to embedding terminal videos to the following modules:

• Live Display
• Progress Display
• Prompt

Or to showcase all of the example programs as videos.

The most important features that this library provides are:

• relatively small (tiny compared to high-res mp4 videos)
• automatically generated (will always be update)
• ensure that example scripts run, otherwise documentation will fail

For more information, please feel free to take a quick look at the official documentation.

Of course, I am the author of the library and am biased, so before even starting to work on creating a PR I would like to start a general discussion.

1. Is this in general something that the rich team would consider?
2. Would it consider depending on an external extension to generate the output?

• For example, there will be no Windows support for the extension in the foreseeable future (at least without hacks on the Windows side)

3. What requirements must the extension fulfill to even justify being considered in a PR?

I am not shy of displaying any short-comings of the extension and am happy to answer any questions you might have :)
An important summary of possible issues can be seen in the limitations section.

Best regards,

Kai