Documentations

[Thanatoz-1]

[Draft]

This MR adds docs and their respective web objects in descending order.
Docs completed so far are:

• Trim
• Time stretch
• Time Mask
• Tanh Distortion
• Shift
• Seven band parametric eq
• Room simulator
• Reverse
• Resample
• Polarity inversion
• Pitch Shift
• Peaking filter
• Padding
• Normalize
• mp3 compression
• Low shelf filter
• Low pass filter
• Loudness normalization
• Limiter
• Lambda
• High shelf filter
• High pass filter
• Gain
• Gain transition
• Clipping distortion
• Clip
• Band stop filter
• Band pass filter
• Apply impulse response
• Air absoption
• Add short noises
• Add gaussian SNR
• Add gaussian noise
• Add background noise

[Thanatoz-1]

Hey @iver56 ,
I am pushing my first documentation [Trim] here. I am considering a document to be complete only if it contains the waveform & spectrogram comparison, and audio samples. Please correct me wherever I might be wrong or else I will continue.

[iver56]

Thanks :) Can you also include your changes in generate_examples_for_doc.py?

[Thanatoz-1]

Certainly, I'll also add changes in the generate_examples_for_doc.py

[iver56]

I just merged some of my own documentation updates btw: #237

[Thanatoz-1]

Thanks, Taking a pull now and updating the MR too.

[iver56]

I will wait for your changes in generate_examples_for_doc.py, and then I think this is ready to be merged

[iver56]

One thing I'm not sure if I like is the dependency on AddGaussianNoise_input.flac

There are pros and cons

Pro:

• We save space in the repository and maybe save a little bit of network bandwidth for users that browse several documentation pages (because cache)

Con:

• Documentation maintenance becomes harder. For example, if I update the audio example in the AddGaussianNoise documentation, other pages that rely on AddGaussianNoise_input.flac will be broken, and it can be hard to discover the error

What do you think? Does the pro outweigh the con?

[Thanatoz-1]

Hey @iver56,

Sorry for not being able to reply sooner. I tried to think over this trade-off and for now, I feel let's try to avoid cons and stick to two separate files for each transform (input and output). I've modified the generate_examples_for_docs.py and have added most of the transforms for now. I'll push all the changes in some time and then you can merge.

[iver56]

Thanks 👍

[iver56]

I took the liberty of doing some minor improvements, I hope you don't mind: #240

It has been deployed to the documentation website now.

I also detected a minor alignment oddity in the Trim figure. It's basically my fault because I didn't think of preparing the plotting script for that case. I added an issue for that here: #239

[Thanatoz-1]

Thanks a lot for merging @iver56. Please feel free to make any changes.

[Thanatoz-1]

Also, for the remaining documents, I will be creating another MR and update the rest of it asap.